Sphinx table-of-contents with super powers
Sphinx Extension: TagTocTree
This is an extension to the documentation engine Sphinx. It allows you to include pages in a table-of-contents by using tags assigned to a page.
How it works
This extension adds a new directive
tagtoctree, which creates a tree-like
table-of-contents, filtering pages by a tag filter.
(*) Sphinx native
The documentation assumes you have a Sphinx project running.
Install using PIP:
pip install sphinx-tagtoctree
In your Sphinx configuration file (
conf.py), add a entry for
extensions = [ 'sphinx_tagtoctree' ]
(Optional) Add configuration value for
tagtoctree_tag. If none is provided, the default
tagtoctreewill be used.
tagtoctree_tag = 'tagtoctree'
Finally, add a
tagtoctreedirective where you want your table-of-contents to be displayed. Example:
.. tagtoctree:: :maxdepth: 1 :glob: :caption: Pages with tag "Product" :tag: Product **
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size sphinx_tagtoctree-0.9.3-py3-none-any.whl (14.3 kB)||File type Wheel||Python version py3||Upload date||Hashes View hashes|
|Filename, size sphinx-tagtoctree-0.9.3.tar.gz (61.0 kB)||File type Source||Python version None||Upload date||Hashes View hashes|
Hashes for sphinx_tagtoctree-0.9.3-py3-none-any.whl