Sphinx extension to produce warnings when a doc needs proofreading.
Dust is a Sphinx extension that emits warnings when a document hasn’t been proofread in a while.
It prevents your doc from accumulating dust!
Install dust from pip:
$ pip install sphinx-dust
Then add it as an extension to your project’s conf.py:
# conf.py extensions = [ 'sphinx_dust', ]
Dust introduces a new directive: reviewer-meta.
It takes two arguments:
Both dates must respect the yyyy-mm-dd format.
Here it is in context:
.. index.rst Rubik's Cube Tutorial --------------------- .. reviewer-meta:: :written-on: 1974-05-19 :proofread-on: 1974-06-20
This directive will be replaced by a note reading:
.. note:: Written on 19 May 1974, proofread on 20 June 1974
Running sphinx-build will output a warning if the number of days spanning between written-on and proofread-on is greater than dust_days_limit. In this case, with dust_days_limit = 30, Sphinx will emit a warning:
/path/to/your/doc/index.rst:2: WARNING: This document hasn't been proofread for 32 days
Using Sphinx’s -W option, warnings will be turned into errors, useful to make CI builds fail and be notified of outdated docs.
The warning and note content are exported using sphinx.locale so you can translate them in your language if you see fit.
Various parameters can be tweaked to your convenience. You can alter any of them in your project’s conf.py file, they’re simple Python variables.
You can assign any value to these settings, however you should respect their typing, the extension could crash otherwise.
Here’s an exhaustive list of every parameter:
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|File Name & Checksum SHA256 Checksum Help||Version||File Type||Upload Date|
|sphinx_dust-1.2.2-py3-none-any.whl (6.4 kB) Copy SHA256 Checksum SHA256||py3||Wheel||Jun 19, 2017|
|sphinx-dust-1.2.2.tar.gz (4.1 kB) Copy SHA256 Checksum SHA256||–||Source||Jun 19, 2017|