1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
# 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](https://jupyterbook.org)!
In normal Sphinx documentation, the documentation site-map is defined *via* a bottom-up approach - adding [`toctree` directives](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#table-of-contents) within pages of the documentation.
This extension facilitates a **top-down** approach to defining the site-map structure, within a single YAML file.
:::{figure-md}
<img src="toc-graphic.png" alt="ToC graphic" width="600px" />
Example ToC
:::
It also allows for documents not specified in the ToC to be auto-excluded.
```{tableofcontents}
```
|
