Registry / devops / sphinxcontrib-log-cabinet

sphinxcontrib-log-cabinet

JSON →
library1.0.1pypypi✓ verified 84d ago

A Sphinx extension that organizes changelog directives (e.g., .. changelog::) into a structured log cabinet. Version 1.0.1 is current; release cadence is low, with maintenance as needed.

devops
pip install sphinxcontrib-log-cabinet
github ↗homepage ↗
INSTALL
IMPORT
SIG · SPHINXCONTRIB-LOG-
S
sphinxcontrib-log-cabinet
devopspythonv1.0.1
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

setup
✓ import sphinxcontrib.log_cabinet
✗ import sphinxcontrib_log_cabinet
Correct module uses dot, not underscore.

Add the extension to Sphinx conf.py, then use the changelog directive.

# In conf.py extensions = ['sphinxcontrib.log_cabinet'] # Then in a .rst file: # .. changelog:: # :version: 1.0.0 # # * First change # * Second change
Debug
Known issues
gotchaThe extension must be listed in extensions as 'sphinxcontrib.log_cabinet' (with dots). Using underscores ('sphinxcontrib_log_cabinet') will not load the extension.
fix
Use 'sphinxcontrib.log_cabinet' in your extensions list.
affects: all
deprecatedThe ``.. log::`` directive was deprecated in version 1.0.0 and may be removed in future. Use ``.. changelog::`` instead.
fix
Replace ``.. log::`` with ``.. changelog::`` in your RST files.
affects: >=1.0.0
Errors
Common errors & fixes
WARNING: unknown directive type "changelog"
Extension not loaded or misspelled in conf.py.
fix
Ensure extensions list includes 'sphinxcontrib.log_cabinet' exactly.
ModuleNotFoundError: No module named 'sphinxcontrib_log_cabinet'
Using underscore instead of dot in import.
fix
Use 'sphinxcontrib.log_cabinet' in your extensions list.
Upgrade
Version history
1.0.1latest on PyPI · released Jul 5, 2019
Audit
Dependencies
SphinxrequiredRuntime dependency; extension loaded in Sphinx conf.py
Agent activity
6 hits · last 30 days
node
6
Resources
githubhttps://github.com/davidism/sphinxcontrib-log-cabinet ↗
homepagehttps://github.com/davidism/sphinxcontrib-log-cabinet ↗
sphinxcontrib-log-cabinet — pip install sphinxcontrib-log-cabinet · libregistry