sphinx-dust 1.2.4

灰尘

dust是sphinx扩展，当文档没有 一会儿就校对好了。

它可以防止你的医生积聚灰尘！

设置

从管道安装灰尘：

$ pip install sphinx-dust

然后将其作为扩展添加到项目的conf.py：

# conf.pyextensions=['sphinx_dust',]

使用灰尘

dust引入了一个新指令：reviewer-meta。

它需要两个参数：

• written-on，文档被编辑的日期；以及，
• proofread-on，文档校对的日期。
• dust-days-limit，重写全局dust_days_limit，以自定义文档可以不经审阅而生存的日期。

两个日期都必须遵循yyyy-mm-dd格式。

这里是上下文：

.. index.rst

Rubik's Cube Tutorial---------------------..reviewer-meta:::written-on:1974-05-19:proofread-on:1974-06-20:dust-days-limit:25

此指令将替换为注释读数：

..note::

    Written on 19 May 1974, proofread on 20 June 1974

运行sphinx-build将输出一个警告，如果跨越的天数 介于written-on和proofread-on之间的值大于dust_days_limit。 在这种情况下，使用dust_days_limit = 30，sphinx将发出警告：

/path/to/your/doc/index.rst:2: WARNING: This document hasn't been proofread for32 days

使用sphinx的-W选项，警告将变为错误，对 使ci构建失败并收到过期文档的通知。

警告和注释内容将使用sphinx.locale导出，以便您可以翻译 如果你觉得合适的话就用你的语言。

配置

可以根据您的方便调整各种参数。你可以改变任何 在项目的conf.py文件中，它们是简单的python变量。

您可以为这些设置分配任何值，但是您应该尊重它们 键入时，扩展可能会崩溃。

下面是每个参数的详尽列表：

• dust_days_limit（默认值：30），文档可以生存的天数 自从上次没有发出警告的回顾之后，
• dust_emit_warnings（默认值：True）控制扩展是否发出 文档需要审阅时发出警告，
• dust_include_output（默认值：True）控制是否包含HTML 在监控文档中输出，
• dust_output_format（默认值："Written on {written_on}, proofread on {proofread_on}"）， HTML输出的内容，需要包含两个格式变量： written_on和proofread_on，它们将被 strftime-格式化written-on和proofread-on值，
• dust_datetime_format（默认值："%d %B %Y"），格式为datetimes （written-on和proofread-on值）接受HTML输出；并且，
• dust_node_classes（默认值：['note']），狮身人面像警告列表 应用于用于生成HTML的节点的类。