{"categories":[{"label":"Python Modules","url":"https://skillfed.io/packages/category/software-development-libraries-python-modules/14"},{"label":"Markup","url":"https://skillfed.io/packages/category/text-processing-markup"}],"enrichment":{"capability":"A Sphinx extension that defines documentation site-maps in a single YAML file using a top-down approach, instead of scattered toctree directives throughout source files.","skillfed_tags":["sphinx-extension","documentation-automation"],"use_cases":["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\u2014only edit the YAML.","Use glob patterns to include entire directories of files matching a naming convention without listing each one explicitly."],"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.\n\nThe 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.","worth_installing":"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."},"id":"sphinx-external-toc","links":{"html":"https://skillfed.io/packages/sphinx-external-toc","md":"https://skillfed.io/packages/sphinx-external-toc.md","pypi":"https://pypi.org/project/sphinx-external-toc/"},"maintenance":{"status":"active"},"meta":{"latest_release":"2026-01-16","license_spdx":null,"license_treatment":"permissive","name":"sphinx_external_toc","python_support":"supports_current","summary":"A sphinx extension that allows the site-map to be defined in a single YAML file."},"popularity":{"monthly_downloads":253638,"position":8512,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"1.1.0"}