Usage

Installation

python3 -m pip install toctree_plus --user

First add the required channels

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

Then install

conda install toctree_plus

python3 -m pip install git+https://github.com/sphinx-toolbox/toctree_plus@master --user

Enable toctree_plus by adding the following to the extensions variable in your conf.py:

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

toctree_plus_types: Type: Dict[str]

Default: {"class", "function", "method"}

This determines the directive types that appear in the toctree.