{
    "info": {
        "author": "Polyconseil",
        "author_email": "opensource+sphinx-dust@polyconseil.fr",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 3 - Alpha",
            "Environment :: Plugins",
            "Framework :: Sphinx :: Extension",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: BSD License",
            "Natural Language :: English",
            "Programming Language :: Python"
        ],
        "description": "Dust\n====\n\nDust is a Sphinx extension that emits warnings when a document hasn't\nbeen proofread in a while.\n\nIt prevents your doc from accumulating dust!\n\n\nSetting up\n==========\n\nInstall dust from pip:\n\n.. code-block:: shell\n\n    $ pip install sphinx-dust\n\nThen add it as an extension to your project's ``conf.py``:\n\n.. code-block:: python\n\n    # conf.py\n    extensions = [\n        'sphinx_dust',\n    ]\n\n\nUsing dust\n==========\n\nDust introduces a new directive: ``reviewer-meta``.\n\nIt takes two arguments:\n\n- ``written-on``, the date the document was redacted; and,\n- ``proofread-on``, the date the document was proofread.\n- ``dust-days-limit``, overrides the global ``dust_days_limit`` to customize the day the document can live without review.\n\nBoth dates must respect the ``yyyy-mm-dd`` format.\n\nHere it is in context:\n\n.. code-block:: rst\n\n    .. index.rst\n\n    Rubik's Cube Tutorial\n    ---------------------\n\n    .. reviewer-meta::\n        :written-on: 1974-05-19\n        :proofread-on: 1974-06-20\n        :dust-days-limit: 25\n\n\nThis directive will be replaced by a note reading:\n\n.. code-block:: rst\n\n    .. note::\n\n        Written on 19 May 1974, proofread on 20 June 1974\n\n\nRunning ``sphinx-build`` will output a warning if the number of days spanning\nbetween ``written-on`` and ``proofread-on`` is greater than ``dust_days_limit``.\nIn this case, with ``dust_days_limit = 30``, Sphinx will emit a warning:\n\n.. code-block:: shell\n\n    /path/to/your/doc/index.rst:2: WARNING: This document hasn't been proofread for 32 days\n\nUsing Sphinx's ``-W`` option, warnings will be turned into errors, useful to\nmake CI builds fail and be notified of outdated docs.\n\nThe warning and note content are exported using sphinx.locale so you can translate\nthem in your language if you see fit.\n\n\nConfiguration\n=============\n\nVarious parameters can be tweaked to your convenience. You can alter any of\nthem in your project's ``conf.py`` file, they're simple Python variables.\n\nYou can assign any value to these settings, however you should respect their\ntyping, the extension could crash otherwise.\n\nHere's an exhaustive list of every parameter:\n\n- ``dust_days_limit`` (default: ``30``), the number of days a document can live\n  since its last reviewing without emitting warnings,\n- ``dust_emit_warnings`` (default: ``True``), controls whether the extension emits a\n  warning when a document needs reviewing,\n- ``dust_include_output`` (default: ``True``), controls whether to include an HTML\n  output in the monitored documents,\n- ``dust_output_format`` (default: ``\"Written on {written_on}, proofread on {proofread_on}\"``),\n  the content of the HTML output, needs to include two format variables:\n  ``written_on`` and ``proofread_on``, which will get replaced by the result of\n  ``strftime``-formatting ``written-on`` and ``proofread-on`` values,\n- ``dust_datetime_format`` (default: ``\"%d %B %Y\"``), the format datetimes\n  (``written-on`` and ``proofread-on`` values) take in HTML output; and,\n- ``dust_node_classes`` (default: ``['note']``), a list of Sphinx admonition\n  classes to apply to the node used to generate HTML.",
        "description_content_type": "",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/Polyconseil/sphinx-dust",
        "keywords": "sphinx documentation review proofread up-to-date",
        "license": "BSD",
        "maintainer": "",
        "maintainer_email": "",
        "name": "sphinx-dust",
        "package_url": "https://pypi.org/project/sphinx-dust/",
        "platform": "",
        "project_url": "https://pypi.org/project/sphinx-dust/",
        "project_urls": {
            "Homepage": "https://github.com/Polyconseil/sphinx-dust"
        },
        "release_url": "https://pypi.org/project/sphinx-dust/1.2.4/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "Sphinx extension to produce warnings when a doc needs proofreading.",
        "version": "1.2.4"
    },
    "last_serial": 4225698,
    "releases": {
        "1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "18d04f42807ee83a99c67bc643a01ea5",
                    "sha256": "eb21b8dad624687afd026a4d21c3528ec9a493a7cb0adbcc4894f823329e43c2"
                },
                "downloads": -1,
                "filename": "sphinx_dust-1.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "18d04f42807ee83a99c67bc643a01ea5",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 5422,
                "upload_time": "2016-08-31T14:33:40",
                "url": "https://files.pythonhosted.org/packages/f2/a3/b14008a33213bddeb8a711b3603ece981e0268839792db080b62258bb622/sphinx_dust-1.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "9c74a4f77ce8b27e2c1f5ddacc0079a0",
                    "sha256": "8152315a51a914c65aaa0e168363f7ba164b4cdee5aef860590421bf8d7a549d"
                },
                "downloads": -1,
                "filename": "sphinx-dust-1.0.tar.gz",
                "has_sig": false,
                "md5_digest": "9c74a4f77ce8b27e2c1f5ddacc0079a0",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 3526,
                "upload_time": "2016-08-31T14:33:42",
                "url": "https://files.pythonhosted.org/packages/9d/f0/a750dd890d55cd001d6426f789a6b2260c049a95d5e84363cf994f6cc6b9/sphinx-dust-1.0.tar.gz"
            }
        ],
        "1.0.dev0": [],
        "1.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "d7671651e9ae3b1591384131017d7995",
                    "sha256": "8c2f20991204ce0b2ee1a44c6b79cffeb995535ed14a6230bf7f00a92d6fd8e0"
                },
                "downloads": -1,
                "filename": "sphinx_dust-1.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "d7671651e9ae3b1591384131017d7995",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 5487,
                "upload_time": "2016-09-21T14:24:24",
                "url": "https://files.pythonhosted.org/packages/f9/0d/297b71bb9d7446340b732ed4475e25cb360a42600e35e16337c63e5bb8db/sphinx_dust-1.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "d483b65b60f86c9924f6ba03b47190bd",
                    "sha256": "2f9ba5446421bd5df63e9033451f55ef1176604059e9984b5bdbc2192bb6c42f"
                },
                "downloads": -1,
                "filename": "sphinx-dust-1.1.tar.gz",
                "has_sig": false,
                "md5_digest": "d483b65b60f86c9924f6ba03b47190bd",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 3545,
                "upload_time": "2016-09-21T14:24:27",
                "url": "https://files.pythonhosted.org/packages/ad/89/1b7f4061c585b674ab64931024d64f33e89e67e5f8aef6196517b4d1e8f7/sphinx-dust-1.1.tar.gz"
            }
        ],
        "1.2.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "c704c3c4b164f54b53ee545dec367161",
                    "sha256": "54f47a97e25483959652241b2a47e64ec56c055da1f4c16b940f2bafc73d84c1"
                },
                "downloads": -1,
                "filename": "sphinx_dust-1.2.1-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "c704c3c4b164f54b53ee545dec367161",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 5498,
                "upload_time": "2017-05-17T13:51:43",
                "url": "https://files.pythonhosted.org/packages/8d/f6/1185636548143d72dfbeec5a02da0761c8cb88b0451ca5d1e68c656b7a88/sphinx_dust-1.2.1-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "fd28f0d15501aa57e4320a7e50953416",
                    "sha256": "ae521a4503df38c125956ec461347cc13c456a86870d7e49012bb4dc1dade6d9"
                },
                "downloads": -1,
                "filename": "sphinx-dust-1.2.1.tar.gz",
                "has_sig": false,
                "md5_digest": "fd28f0d15501aa57e4320a7e50953416",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 3544,
                "upload_time": "2017-05-17T13:51:45",
                "url": "https://files.pythonhosted.org/packages/4e/0a/c456966f8803a2bb01f60c74d63bc2fd0107c254eb6bc4d1ee943205615b/sphinx-dust-1.2.1.tar.gz"
            }
        ],
        "1.2.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "2e5e0dcd462963d4931255106c3cbf5c",
                    "sha256": "c24a1a637d66f6417fcc1bd61d955474dc1c685d07824c15e958b15bb159bf59"
                },
                "downloads": -1,
                "filename": "sphinx_dust-1.2.2-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "2e5e0dcd462963d4931255106c3cbf5c",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 6413,
                "upload_time": "2017-06-19T13:47:52",
                "url": "https://files.pythonhosted.org/packages/a9/66/bb110610b12c7f02bf4bb83c3745d5aec625101e3ff72d588b376802a5db/sphinx_dust-1.2.2-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "5809251ef72a49feb2389f1742f9c118",
                    "sha256": "103dffd142957ce710224e94dd4ef3d7874719317e8a7bc1c1d27b4644d50452"
                },
                "downloads": -1,
                "filename": "sphinx-dust-1.2.2.tar.gz",
                "has_sig": false,
                "md5_digest": "5809251ef72a49feb2389f1742f9c118",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4079,
                "upload_time": "2017-06-19T13:47:54",
                "url": "https://files.pythonhosted.org/packages/7e/9c/80183f1e7bf02131d3f8870b49ec7ccdab30183e479b64bd90e8202afed8/sphinx-dust-1.2.2.tar.gz"
            }
        ],
        "1.2.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "99c8e0cbfd2fd85922e2a2530dfee096",
                    "sha256": "36ba86005e90009b0794974736298c9bd5af81853e17fa88ffd6977d54897f4b"
                },
                "downloads": -1,
                "filename": "sphinx_dust-1.2.3-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "99c8e0cbfd2fd85922e2a2530dfee096",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 9322,
                "upload_time": "2017-08-21T08:52:28",
                "url": "https://files.pythonhosted.org/packages/c0/b5/e6c0f957d1cd55930e3ad5de8725ce1f98d71bf0b4e574a20f2d9258402e/sphinx_dust-1.2.3-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "d85ec2480f98d944f1eaf33744df9508",
                    "sha256": "7dc0dd66480abfec22a3bee9c0ee873aac180932a2dcd00d061fe0a18562c293"
                },
                "downloads": -1,
                "filename": "sphinx-dust-1.2.3.tar.gz",
                "has_sig": false,
                "md5_digest": "d85ec2480f98d944f1eaf33744df9508",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4153,
                "upload_time": "2017-08-21T08:54:03",
                "url": "https://files.pythonhosted.org/packages/32/c1/1037608492f72969fa78ef1df3ac21a1d23e56d03db2c3b528efacbf5224/sphinx-dust-1.2.3.tar.gz"
            }
        ],
        "1.2.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "110319768466ce56d2044ace2cea761e",
                    "sha256": "ea61feddc0eadbd1fd252d7b9b05f85fba4ea3f567f26a8cabe619917239d42e"
                },
                "downloads": -1,
                "filename": "sphinx_dust-1.2.4-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "110319768466ce56d2044ace2cea761e",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 4315,
                "upload_time": "2018-08-31T08:52:58",
                "url": "https://files.pythonhosted.org/packages/79/31/9a28c08f131312864e02bfc48c95b0adfa61893f7e5cf59e54d29c4e0776/sphinx_dust-1.2.4-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "a537a6a37200c5b0fdb898cb281f5b09",
                    "sha256": "0d7b4dfad9860f525c4313fc4ec8edcb13634f901fbece77f966e5adf5005739"
                },
                "downloads": -1,
                "filename": "sphinx-dust-1.2.4.tar.gz",
                "has_sig": false,
                "md5_digest": "a537a6a37200c5b0fdb898cb281f5b09",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4242,
                "upload_time": "2018-08-31T08:52:56",
                "url": "https://files.pythonhosted.org/packages/ff/9d/795079692519ade2a0013328aa74616b630fa4895ddc0362b1d6c411ed3d/sphinx-dust-1.2.4.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "110319768466ce56d2044ace2cea761e",
                "sha256": "ea61feddc0eadbd1fd252d7b9b05f85fba4ea3f567f26a8cabe619917239d42e"
            },
            "downloads": -1,
            "filename": "sphinx_dust-1.2.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "110319768466ce56d2044ace2cea761e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 4315,
            "upload_time": "2018-08-31T08:52:58",
            "url": "https://files.pythonhosted.org/packages/79/31/9a28c08f131312864e02bfc48c95b0adfa61893f7e5cf59e54d29c4e0776/sphinx_dust-1.2.4-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "a537a6a37200c5b0fdb898cb281f5b09",
                "sha256": "0d7b4dfad9860f525c4313fc4ec8edcb13634f901fbece77f966e5adf5005739"
            },
            "downloads": -1,
            "filename": "sphinx-dust-1.2.4.tar.gz",
            "has_sig": false,
            "md5_digest": "a537a6a37200c5b0fdb898cb281f5b09",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 4242,
            "upload_time": "2018-08-31T08:52:56",
            "url": "https://files.pythonhosted.org/packages/ff/9d/795079692519ade2a0013328aa74616b630fa4895ddc0362b1d6c411ed3d/sphinx-dust-1.2.4.tar.gz"
        }
    ]
}