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.

Source Distribution

sphinxcontrib-log-cabinet-1.0.1.tar.gz (4.1 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page