sphinx-external-toc

A sphinx extension that allows the documentation site-map (a.k.a Table of Contents) to be defined external to the documentation files. As used by Jupyter Book!

In normal Sphinx documentation, the documentation site-map is defined via a bottom-up approach - adding toctree directives within pages of the documentation.

This extension facilitates a top-down approach to defining the site-map structure, within a single YAML file.

Example ToC

It also allows for documents not specified in the ToC to be auto-excluded.

User Guide

• 1. Sphinx
  • 1.1. Configuration
  • 1.2. Basic Structure
  • 1.3. File and URL titles
  • 1.4. ToC tree options
  • 1.5. Using different key-mappings
  • 1.6. Excluding files not in ToC
• 2. Command-line
• 3. API

Example

• Example Project

Links

• GitHub Repository