Skip to main content

Organize changelog directives in Sphinx docs.

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sphinxcontrib-log-cabinet, version 1.0.1
Filename, size File type Python version Upload date Hashes
Filename, size sphinxcontrib_log_cabinet-1.0.1-py2.py3-none-any.whl (4.9 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size sphinxcontrib-log-cabinet-1.0.1.tar.gz (4.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page