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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file sphinxcontrib-log-cabinet-1.0.1.tar.gz
.
File metadata
- Download URL: sphinxcontrib-log-cabinet-1.0.1.tar.gz
- Upload date:
- Size: 4.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 103b2e62df4e57abb943bea05ee9c2beb7da922222c8b77314ffd6ab9901c558 |
|
MD5 | 50e9b6e692689c605862a3f9b5c6c936 |
|
BLAKE2b-256 | 75260687391e10c605a4d0c7ebe118c57c51ecc687128bcdae5803d9b96def81 |
File details
Details for the file sphinxcontrib_log_cabinet-1.0.1-py2.py3-none-any.whl
.
File metadata
- Download URL: sphinxcontrib_log_cabinet-1.0.1-py2.py3-none-any.whl
- Upload date:
- Size: 4.9 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3decc888e8e453d1912cd95d50efb0794a4670a214efa65e71a7de277dcfe2cd |
|
MD5 | 9043423f8e004e7526d1687c4caa8e7e |
|
BLAKE2b-256 | 27e7dbfc155c1b4c429a9a8149032a56bfb7bab4efabc656abb24ab4619c715d |