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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file toctree_plus-0.0.1.tar.gz.

File metadata

  • Download URL: toctree_plus-0.0.1.tar.gz
  • Upload date:
  • Size: 6.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.6.7

File hashes

Hashes for toctree_plus-0.0.1.tar.gz
Algorithm Hash digest
SHA256 35949362206a3331082df4c8641bb61fd3fbc293d4a6681916cb1dc9b7e0b2a3
MD5 9036517467bea24af29767a3d6a550a0
BLAKE2b-256 9859d252954613c8a56eb81b3ea83e19fff1bd401db118210f5bbe4d547a0f3c

See more details on using hashes here.

File details

Details for the file toctree_plus-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: toctree_plus-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 6.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.48.0 CPython/3.6.7

File hashes

Hashes for toctree_plus-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c92665944c86840b5eeec9c38946a996eb3c469f4cc1a0444830dc38791547ad
MD5 02c40075c68e4e109555004f9ebbad25
BLAKE2b-256 65cc22fe95c7f3ebc6e45ad08b1e36d21a3baf42ba9783b266972dccc8c4adda

See more details on using hashes here.

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