changelog
Provides simple Sphinx markup to render changelog displays.
Decision gist · record as of 2026-08-14
Yes, if you maintain a Sphinx-based project and want structured changelog markup. The extension is actively maintained, has no security vulnerabilities, and low install friction. The MIT license is permissive. The main caveat is that it is marked experimental and has a small user base, so community support is limited—verify compatibility with your Sphinx version before committing.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Sphinx to be installed and a Sphinx documentation project configured.
- Low install friction; pure Python wheel with three runtime dependencies (Sphinx, docutils, looseversion).
- Actively maintained with no known vulnerabilities.
License · maintenance · safety
MIT (permissive) — MIT license permits unrestricted use, modification, and distribution with minimal restrictions—suitable for both open-source and proprietary projects.
last release 2025-12-20 (237 days) · last repo commit 2026-04-16 · 6 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 129,394 downloads/mo, #11,672 on PyPI
Alternatives
Verify before relying
# Install
pip install changelog
# In conf.py, add to extensions list:
extensions = ['changelog']
# In your .rst file, use the directive:
# .. changelog::
# :version: 1.5.6
# :released: Sun Oct 12 2008
#
# .. change::
# :tags: general
# :tickets: 27
#
# Description of the change.- Whether the package works with current Sphinx versions or has known compatibility issues with recent releases.
- Whether the experimental status noted in the description means breaking changes are likely or if it is stable in practice.
- What specific Python versions are supported beyond the general Python 3 classifier.
What it is and what it does
Changelog is a Sphinx extension that provides markup directives to structure and render changelog entries in documentation. It lets you organize changes by version, tag them by category, and link to tickets, pull requests, and changesets. The extension groups and sorts changes according to configuration, supporting both simple tags and compound tags that match multiple categories.
The package is used by SQLAlchemy and related projects. It is marked experimental but appears stable in practice. It depends on Sphinx, docutils, and looseversion, and runs as a pure Python wheel with no compiled dependencies. The extension also supports advanced features like importing changes from multiple files, rendering to markdown, and a command-line tool for gathering per-file changelog entries at release time.
Use it for
- Organize release notes by version and category in Sphinx-based project documentation.
- Link changelog entries to tickets, pull requests, and changesets using configurable URL templates.
- Group related changes under compound tags to show hierarchical change categories.
- Import changelog entries from multiple .rst files to enable per-file change tracking during development.
- Generate markdown changelogs from reStructuredText for use in GitHub releases or web GUIs.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you maintain a Sphinx-based project and want structured changelog markup.
The extension is actively maintained, has no security vulnerabilities, and low install friction. The MIT license is permissive. The main caveat is that it is marked experimental and has a small user base, so community support is limited—verify compatibility with your Sphinx version before committing.
Install
changelog on PyPI
Before you install
Low install friction; pure Python wheel with three runtime dependencies (Sphinx, docutils, looseversion). Actively maintained with no known vulnerabilities.
Requires Sphinx to be installed and a Sphinx documentation project configured.
License in practice
MIT license permits unrestricted use, modification, and distribution with minimal restrictions—suitable for both open-source and proprietary projects.
Quickstart
# Install
pip install changelog
# In conf.py, add to extensions list:
extensions = ['changelog']
# In your .rst file, use the directive:
# .. changelog::
# :version: 1.5.6
# :released: Sun Oct 12 2008
#
# .. change::
# :tags: general
# :tickets: 27
#
# Description of the change.Verify before relying
- Whether the package works with current Sphinx versions or has known compatibility issues with recent releases.
- Whether the experimental status noted in the description means breaking changes are likely or if it is stable in practice.
- What specific Python versions are supported beyond the general Python 3 classifier.
Package facts
| License | MIT permissive |
| Python support | Not specified |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 3 packagesSphinxdocutilslooseversion |
| Maintenance | Actively maintained 237 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 129,394 / month, #11,672 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 3 - AlphaEnvironment :: ConsoleIntended Audience :: DevelopersProgramming Language :: PythonProgramming Language :: Python :: 3Programming Language :: Python :: Implementation :: CPythonProgramming Language :: Python :: Implementation :: PyPyTopic :: Documentation |
Evidence: changelog-0.6.2-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 extension”
- changelogA Sphinx extension that generates formatted changelog displays from…
- sphinxcontrib-towncrierA Sphinx extension that automatically injects a Towncrier-generated…
- sphinxcontrib-log-cabinetA Sphinx extension that organizes changelog entries generated by…
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 sphinxcontrib-log-cabinet · sphinxcontrib-towncrier · sphinx_mdinclude · sphinx-jinja · m2r2 · sphinx-substitution-extensions · reno · sphinxcontrib-httpdomain · gitchangelog · blurb