sphinx-filtered-toctree
sphinx-filtered-toctree allows you to filter pages out of your documentation's navigation by prefixing ToC entries with configurable tags.
Basic usage
First, list the tags you wish to exclude with toc_filter_exclude in your conf.py
file:
toc_filter_exclude = ["exclude", "hidden"]
To filter entries out of your documentation's navigation, prefix either the document's
label or target with one of the tags defined in toc_filter_exclude:
.. filtered-toctree::
:exclude:how-to-code
Unit testing <:hidden:unit-testing>
Aside from this added functionality, filtered-toctree behaves exactly the same as
the toctree directive.
Project setup
sphinx-filtered-toctree is published on PyPI and can be installed with:
pip install sphinx-filtered-toctree
After adding filtered-toctree to your Python project, update your Sphinx's conf.py file to include filtered-toctree as one of its extensions:
extensions = [
"sphinx_filtered_toctree"
]
Community and support
You can report any issues or bugs on the project's GitHub repository.
filtered-toctree is covered by the Ubuntu Code of Conduct.
License and copyright
sphinx-filtered-toctree is released under the GPL-3.0 license.
© 2025 Canonical Ltd.
Release files for sphinx-filtered-toctree 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| sphinx_filtered_toctree-0.1.0.tar.gz | 103.7 kB | With provenance | Details for sphinx_filtered_toctree-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sphinx_filtered_toctree-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for sphinx_filtered_toctree-0.1.0-py3-none-any.whl |
Total release size: 120.7 kB
Release files / sphinx_filtered_toctree-0.1.0.tar.gz
| Download URL | sphinx_filtered_toctree-0.1.0.tar.gz |
|---|---|
| Size | 103.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
897d07e168b6b3486aaef84ce017580a2668f5c2ed53d0c88478b7411591ee48
|
|
BLAKE2b-256 checksum How to use checksums |
ab344d7b00b47d3a0b06b6660027a92a17a77824c26c9dd1372bedfaf797f79c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 13, 2025.
Transparency logRelease files / sphinx_filtered_toctree-0.1.0-py3-none-any.whl
| Download URL | sphinx_filtered_toctree-0.1.0-py3-none-any.whl |
|---|---|
| Size | 17.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
34b9ab56ccea36800837930b5020d74084742afa305cb467591081d1638a9933
|
|
BLAKE2b-256 checksum How to use checksums |
6c35df331d2c25c62c4fa127dffe37cb92c3d0acef80c6cc030d78d88a01bcff
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 13, 2025.
Transparency logSecurity for sphinx-filtered-toctree 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for sphinx_filtered_toctree-0.1.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 13, 2025.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
