sphinxcontrib-log-cabinet

What it is and what it does

sphinxcontrib-log-cabinet is a Sphinx extension that automatically collects and organizes changelog entries marked with Sphinx's built-in versionadded, versionchanged, and deprecated directives. It generates a unified changelog log sorted from newest to oldest version, and for HTML documentation, older version entries are collapsed by default to keep the page concise. You enable it by adding it to your Sphinx conf.py extensions list, and you can optionally configure it to collapse all changes including the current ones.

The extension is designed for projects that use Sphinx's standard versioning directives throughout their documentation and want a consolidated, organized changelog view without manually maintaining a separate changelog file. It's a lightweight addition to the Sphinx build process with only Sphinx itself as a dependency.

Use it for:

• Generate an organized changelog from scattered versionadded and deprecated directives in your Sphinx docs.
• Collapse older version entries in HTML docs to reduce visual clutter while keeping recent changes visible.
• Track deprecations and version-specific changes across a large documentation set without a separate changelog file.
• Present version history in reverse chronological order for readers to quickly find what changed in recent releases.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

A Sphinx extension that organizes changelog entries generated by versionadded, versionchanged, and deprecated directives into a collapsible, reverse-chronologically sorted log.

No. The package is abandoned (last release 2019, last commit 2022) and will not receive updates for modern Sphinx versions. If your Sphinx setup is locked to an older version and you need this specific changelog organization, it may work, but you should expect compatibility issues as Sphinx evolves. For new projects, consider maintaining a changelog separately or using an actively maintained alternative.

Install

sphinxcontrib-log-cabinet on PyPI

pip install sphinxcontrib-log-cabinet

uv add sphinxcontrib-log-cabinet

poetry add sphinxcontrib-log-cabinet

Installing sphinxcontrib-log-cabinet

Before you install

Low friction install with a single runtime dependency on Sphinx. However, the package is abandoned—last release was 2019-07-05 and last commit 2022-11-19—so it will not receive bug fixes or updates for newer Sphinx versions.

License in practice

BSD-3-Clause is permissive, allowing commercial and private use with minimal restrictions; you may use and modify this code freely as long as you retain the license notice.

Quickstart

pip install sphinxcontrib-log-cabinet

Then in conf.py:
extensions = [
    "sphinxcontrib.log_cabinet",
]

Optionally set log_cabinet_collapse_all = True to collapse all changes.

Verify before relying

• Whether the extension remains compatible with current Sphinx versions (last tested/released in 2019).
• Whether HTML output collapsing behavior works with modern browser JavaScript and Sphinx themes.

Package facts

Evidence: sphinxcontrib_log_cabinet-1.0.1-py2.py3-none-any.whl

Tags

More Documentation packages