Skip to content

Commit e54db50

Browse files
committed
📚 DOCS: Link to jupyter book
1 parent 697ceed commit e54db50

File tree

2 files changed

+2
-0
lines changed

2 files changed

+2
-0
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
[![PyPI][pypi-badge]][pypi-link]
77

88
A sphinx extension that allows the documentation site-map (a.k.a Table of Contents) to be defined external to the documentation files.
9+
As used by [Jupyter Book](https://jupyterbook.org)!
910

1011
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.
1112

docs/intro.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# sphinx-external-toc
22

33
A sphinx extension that allows the documentation site-map (a.k.a Table of Contents) to be defined external to the documentation files.
4+
As used by [Jupyter Book](https://jupyterbook.org)!
45

56
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.
67

0 commit comments

Comments
 (0)