Skip to main content

Enhanced Sphinx TocTree that shows classes and functions as if they were sections.

Project description

Docs

Documentation Status Docs Check Status

Tests

Travis Build Status Windows Tests Status macOS Tests Status CodeFactor Grade

PyPI

PyPI - Package Version PyPI - Supported Python Versions PyPI - Supported Implementations PyPI - Wheel

Activity

GitHub last commit GitHub commits since tagged version Maintenance

Other

License GitHub top language Requirements Status pre-commit

Installation

toctree_plus can be installed from PyPI.

To install with pip:

$ python -m pip install toctree_plus

Enable toctree_plus by adding “sphinxcontrib.toctree_plus” to the extensions variable in conf.py:

extensions = [
        ...
        "sphinxcontrib.toctree_plus",
        ]

For more information see https://www.sphinx-doc.org/en/master/usage/extensions/index.html#third-party-extensions .

Future Enhancements

  • Support different methods of defining the requirements, e.g. setup.py or pyproject.toml.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

toctree_plus-0.0.1.tar.gz (6.7 kB view hashes)

Uploaded Source

Built Distribution

toctree_plus-0.0.1-py3-none-any.whl (6.1 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page