/sphinxcontrib-log-cabinet

Organize changelog directives in Sphinx docs.

Primary LanguagePythonBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

sphinxcontrib-log-cabinet

Organize changelogs generated by versionadded, versionchanged, deprecated directives. The log will be sorted by newest to oldest version. For HTML docs, older versions will be collapsed by default.

Install:

$ pip install sphinxcontrib-log-cabinet

Enable:

extensions = [
    ...,
    "sphinxcontrib.log_cabinet",
    ...,
]

Configure:

log_cabinet_collapse_all

By default, current changes and deprecations are not collapsed. Set this to True to collapse all changes.