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

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for DomDF from gravatar.com DomDF

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: BSD License (BSD-3-Clause)
  • Author: Dominic Davis-Foster
  • Tags documentation, sphinx, sphinx-extension
  • Requires: Python >=3.6
Classifiers
Report project as malware

Project description

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

Docs

Documentation Build Status Docs Check Status

Tests

Linux Test Status Windows Test Status macOS Test Status Coverage

PyPI

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

Anaconda

Conda - Package Version Conda - Platform

Activity

GitHub last commit GitHub commits since tagged version Maintenance PyPI - Downloads

QA

CodeFactor Grade Flake8 Status mypy status pre-commit.ci status

Other

License GitHub top language Requirements Status

Installation

toctree_plus can be installed from PyPI or Anaconda.

To install with pip:

$ python -m pip install toctree_plus

To install with conda:

  • First add the required channels

$ conda config --add channels http://conda.anaconda.org/conda-forge
$ conda config --add channels http://conda.anaconda.org/domdfcoding

  • Then install

$ conda 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 .

Configuration

There is currently only a single configuration option: toctree_plus_types. This determines the directive types that appear in the toctree. The default value is {"class", "function", "method"}.

Supported by

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