https://github.com/davidism/sphinxcontrib-log-cabinet

Organize changelog directives in Sphinx docs.
https://github.com/davidism/sphinxcontrib-log-cabinet

changelog documentation sphinx sphinx-extension

Last synced: over 1 year ago
JSON representation

Organize changelog directives in Sphinx docs.

• Host: GitHub
• URL: https://github.com/davidism/sphinxcontrib-log-cabinet
• Owner: davidism
• License: bsd-3-clause
• Created: 2017-05-05T00:04:27.000Z (about 9 years ago)
• Default Branch: main
• Last Pushed: 2022-11-19T02:52:30.000Z (over 3 years ago)
• Last Synced: 2025-03-01T10:36:41.006Z (over 1 year ago)
• Topics: changelog, documentation, sphinx, sphinx-extension
• Language: Python
• Homepage: https://pypi.org/project/sphinxcontrib-log-cabinet
• Size: 15.6 KB
• Stars: 13
• Watchers: 2
• Forks: 4
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE.rst

Awesome Lists containing this project

README

          
sphinxcontrib-log-cabinet

=========================

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:

.. code-block:: text

    $ pip install sphinxcontrib-log-cabinet

Enable:

.. code-block:: python

    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.