sphinx_external_toc
A sphinx extension that allows the site-map to be defined in a single YAML file.
Decision gist · record as of 2026-08-14
Yes, if you use Sphinx and want a cleaner, more maintainable way to manage documentation structure. The extension is actively maintained, has no known vulnerabilities, low install friction, and is already the default in Jupyter Book. It is most valuable for projects with many pages or frequent structural changes. For small, simple documentation, the benefit is marginal.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Sphinx and Python 3.9 or later.
- The external_toc_path is always read as a Unix path relative to the source directory.
- Low friction installation with a pure Python wheel.
License · maintenance · safety
permissive license (permissive) — Permissive license treatment means you can use this in commercial and proprietary projects without restriction or obligation to share modifications.
last release 2026-01-16 (210 days) · last repo commit 2026-08-10 · 35 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 253,638 downloads/mo, #8,512 on PyPI
Alternatives
Verify before relying
pip install sphinx-external-toc
# In conf.py:
extensions = ["sphinx_external_toc"]
external_toc_path = "_toc.yml"
# In _toc.yml:
root: intro
entries:
- file: chapter1
- file: chapter2- Whether the extension handles complex nested structures (depth limits, performance with large ToCs) without documented constraints.
- Compatibility with Sphinx versions beyond those implied by the current dependency specification.
- Real-world adoption rate or production use beyond Jupyter Book's default inclusion.
What it is and what it does
sphinx-external-toc is a Sphinx extension that moves table-of-contents definition from a bottom-up, file-by-file approach (using toctree directives scattered throughout documentation) to a top-down, centralized YAML file. Instead of adding toctree directives within each page, you define the entire site structure in a single _toc.yml file, specifying which documents appear where, in what order, and with what options. This is particularly useful for large documentation projects where the structure needs to be managed as a whole rather than piecemeal.
The extension supports recursive nesting, glob patterns for matching multiple files, external URLs, custom titles, and advanced toctree options like numbering styles (numerical, roman, alphabetic), depth limits, and caption text. It is included by default in Jupyter Book, making it a natural choice for projects in that ecosystem. The extension also allows auto-exclusion of documents not mentioned in the ToC, helping keep documentation organized and intentional.
Use it for
- Define a multi-chapter book or tutorial structure in a single YAML file instead of editing toctree directives across many source files.
- Manage large Jupyter Book projects where the documentation hierarchy needs to be centralized and version-controlled as one artifact.
- Apply consistent numbering schemes (roman numerals, alphabetic, etc.) across multiple sections without repeating configuration in each file.
- Automatically exclude undocumented or orphaned files from the build by setting external_toc_exclude_missing.
- Reorganize documentation structure without touching individual source files—only edit the YAML.
- Use glob patterns to include entire directories of files matching a naming convention without listing each one explicitly.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you use Sphinx and want a cleaner, more maintainable way to manage documentation structure.
The extension is actively maintained, has no known vulnerabilities, low install friction, and is already the default in Jupyter Book. It is most valuable for projects with many pages or frequent structural changes. For small, simple documentation, the benefit is marginal.
Install
sphinx-external-toc on PyPI
Before you install
Low friction installation with a pure Python wheel. Actively maintained as of 2026-01-16 with recent commits. Four runtime dependencies (click, pyyaml, sphinx, sphinx-multitoc-numbering) are all standard Sphinx ecosystem packages.
Requires Sphinx and Python 3.9 or later. The external_toc_path is always read as a Unix path relative to the source directory.
License in practice
Permissive license treatment means you can use this in commercial and proprietary projects without restriction or obligation to share modifications.
Quickstart
pip install sphinx-external-toc
# In conf.py:
extensions = ["sphinx_external_toc"]
external_toc_path = "_toc.yml"
# In _toc.yml:
root: intro
entries:
- file: chapter1
- file: chapter2Verify before relying
- Whether the extension handles complex nested structures (depth limits, performance with large ToCs) without documented constraints.
- Compatibility with Sphinx versions beyond those implied by the current dependency specification.
- Real-world adoption rate or production use beyond Jupyter Book's default inclusion.
Package facts
| License | permissive license permissive |
| Python support | Supports the current Python release >=3.9 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 4 packagesclickpyyamlsphinxsphinx-multitoc-numbering |
| Maintenance | Actively maintained 210 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 253,638 / month, #8,512 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 3 - AlphaFramework :: Sphinx :: ExtensionIntended Audience :: DevelopersLicense :: OSI Approved :: MIT LicenseProgramming Language :: Python :: 3Programming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.9Programming Language :: Python :: Implementation :: CPythonTopic :: Software Development :: Libraries :: Python ModulesTopic :: Text Processing :: Markup |
Evidence: sphinx_external_toc-1.1.0-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “sphinx table of contents yaml”
- sphinx_external_tocA Sphinx extension that defines documentation site-maps in a single…
- autoclasstocGenerates a structured table of contents for auto-documented Python…
- autodocsummA Sphinx extension that enhances autodoc with automatic summary…
Give your agent the search over MCP, or paste the wish link into any chat.
More Python Modules packages
Converts domain names between Unicode and ASCII-compatible encoding (Punycode) according to IDNA 2008 and Unicode Technical Standard 46, with security validation and broader script coverage than the standard library.
Install it if you work with internationalized domain names, need to validate domains, or use HTTP clients that depend on it transitively.
Setuptools is a Python build backend and package management tool that handles building, distributing, and installing Python packages, including support for C/C++ extension modules.
PyYAML parses and emits YAML 1.1 data format, enabling serialization and deserialization of configuration files and Python objects to and from human-readable YAML text.
Pydantic validates Python data structures against type hints, coercing and checking input at runtime to ensure it matches a declared schema.
Provides reusable metadata objects for use with PEP-593 `typing.Annotated` to express common constraints like bounds, collection sizes, and predicates on types.
Install it if you use or build libraries that need to express type constraints in a standardized, inspectable way—or if you want to annotate your own types with…
Provides runtime tools to inspect and introspect Python type annotations, enabling programmatic examination of type hints at execution time.
See also sphinx-multitoc-numbering · sphinx-remove-toctrees · autoclasstoc · sphinx-jupyterbook-latex · bidict · sphinxcontrib.datatemplates · sphinxcontrib-autoyaml · changelog · sphinx-jsonschema · sphinx-togglebutton