Metadata-Version: 2.4
Name: sphinxcontrib-log-cabinet
Version: 1.0.1
Summary: Organize changelog directives in Sphinx docs.
Home-page: https://github.com/davidism/sphinxcontrib-log-cabinet
Author: David Lord
Author-email: davidism@gmail.com
License: BSD-3-Clause
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
License-File: LICENSE.rst
Requires-Dist: Sphinx
Dynamic: license-file

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.
