sphinxcontrib-log-cabinet
Organize changelog directives in Sphinx docs.
Decision gist · record as of 2026-08-14
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.AI-flagged interpretation of the facts on this page — verify before relying
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 · maintenance · safety
BSD-3-Clause (permissive) — 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.
last release 2019-07-05 (2597 days) · last repo commit 2022-11-19 · 15 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 100,649 downloads/mo, #12,979 on PyPI
Alternatives
Verify before relying
pip install sphinxcontrib-log-cabinet
Then in conf.py:
extensions = [
"sphinxcontrib.log_cabinet",
]
Optionally set log_cabinet_collapse_all = True to collapse all changes.- 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.
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 on it.
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
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
| License | BSD-3-Clause permissive |
| Python support | Not specified |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 1 packageSphinx |
| Maintenance | Abandoned 2,597 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 100,649 / month, #12,979 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableIntended Audience :: DevelopersLicense :: OSI Approved :: BSD LicenseOperating System :: OS IndependentProgramming Language :: PythonProgramming Language :: Python :: 2Programming Language :: Python :: 3Topic :: DocumentationTopic :: Documentation :: Sphinx |
Evidence: sphinxcontrib_log_cabinet-1.0.1-py2.py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “sphinx changelog organizer”
- sphinxcontrib-log-cabinetA Sphinx extension that organizes changelog entries generated by…
- changelogA Sphinx extension that generates formatted changelog displays from…
- sphinxcontrib-towncrierA Sphinx extension that automatically injects a Towncrier-generated…
Give your agent the search over MCP, or paste the wish link into any chat.
More Documentation packages
Docutils converts plaintext documentation in reStructuredText format into multiple output formats including HTML, XML, and LaTeX using a modular processing system.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
Griffe extracts the complete structure and signatures of Python programs to generate API documentation or detect breaking changes in your project's public API.
Install it if you need to programmatically inspect Python code structure, generate API docs, or enforce API stability in CI.
A Sphinx extension that outputs documentation in serialized HTML formats (JSON and pickle) alongside standard HTML.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
A Sphinx extension that generates HTML help files from reStructuredText documentation source.
See also changelog · reno · sphinx-substitution-extensions · sphinx-togglebutton · sphinx-panels · sphinxcontrib-confluencebuilder · sphinxcontrib-youtube · sphinxcontrib-images · sphinx_mdinclude · sphinx-multiversion