♻️ REFACTOR: Delegate ToC logic to sphinx-external-toc

.gitignore

@@ -50,7 +50,7 @@ coverage.xml
 *.py,cover
 .hypothesis/
 .pytest_cache/
-*_build
+_build
 
 
 # Translations

.pre-commit-config.yaml

@@ -18,16 +18,21 @@ repos:
     - id: trailing-whitespace
 
   - repo: https://github.com/mgedmin/check-manifest
-    rev: "0.39"
+    rev: "0.44"
     hooks:
     - id: check-manifest
 
-  - repo: https://gitlab.com/pycqa/flake8
-    rev: 3.7.9
+  - repo: https://github.com/pycqa/isort
+    rev: 5.8.0
     hooks:
-    - id: flake8
+    - id: isort
 
   - repo: https://github.com/psf/black
     rev: 20.8b1
     hooks:
     - id: black
+
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: 3.8.4
+    hooks:
+    - id: flake8

MANIFEST.in

@@ -13,7 +13,6 @@ recursive-exclude scripts *
 
 exclude .pre-commit-config.yaml
 exclude .readthedocs.yml
-exclude .flake8
 exclude tox.ini
 exclude codecov.yml
 exclude RELEASES.md

docs/_toc.yml

@@ -1,6 +1,7 @@
-- file: intro
-
-- part: Tutorials
+format: jb-book
+root: intro
+parts:
+- caption: Tutorials
   chapters:
   - file: start/your-first-book
     sections:
@@ -10,8 +11,7 @@
     - file: start/publish
   - file: tutorials/references
   - file: basics/questions
-
-- part: Create your book
+- caption: Create your book
   chapters:
   - file: customize/toc
   - file: basics/create
@@ -28,13 +28,12 @@
     - file: interactive/hiding
   - file: file-types/index
     sections:
-      - file: file-types/markdown
-      - file: file-types/notebooks
-      - file: file-types/myst-notebooks
-      - file: file-types/jupytext
-      - file: file-types/restructuredtext
-
-- part: Build your book
+    - file: file-types/markdown
+    - file: file-types/notebooks
+    - file: file-types/myst-notebooks
+    - file: file-types/jupytext
+    - file: file-types/restructuredtext
+- caption: Build your book
   chapters:
   - file: basics/build
   - file: execute/index
@@ -43,8 +42,7 @@
     - file: content/execute
   - file: interactive/interactive
   - file: basics/page
-
-- part: Publish your book
+- caption: Publish your book
   chapters:
   - file: publish/web
     sections:
@@ -56,24 +54,20 @@
     sections:
     - file: interactive/comments/hypothesis
     - file: interactive/comments/utterances
-
   - file: advanced/html
   - file: advanced/pdf
-
-- part: Advanced usage
+- caption: Advanced usage
   chapters:
   - file: advanced/sphinx
   - file: advanced/windows
   - file: explain/sphinx
-
-- part: Reference
+- caption: Reference
   chapters:
   - file: customize/config
   - file: reference/cheatsheet
   - file: reference/cli
   - file: reference/glossary
-
-- part: About Jupyter Book
+- caption: About Jupyter Book
   chapters:
   - url: https://executablebooks.org/en/latest/gallery.html
     title: Gallery of Jupyter Books

docs/reference/cli.md

@@ -17,7 +17,7 @@ For example: `jupyter-book build mybook/` is equivalent to ``jb build mybook/``.
 **See below for the full command-line reference**
 
 ```{eval-rst}
-.. click:: jupyter_book.commands:main
+.. click:: jupyter_book.cli.main:main
    :prog: jupyter-book
    :nested: full
 ```

jupyter_book/__init__.py

@@ -1,12 +1,9 @@
 """Build a book with Jupyter Notebooks and Sphinx."""
 from pathlib import Path
 
-from .toc import add_toc_to_sphinx, add_toctree
-from .directive.toc import TableofContents, SwapTableOfContents
 from sphinx.util import logging
 
-
-__version__ = "0.10.2"
+__version__ = "0.11.0a1"
 
 logger = logging.getLogger(__name__)
 
@@ -25,25 +22,10 @@ def add_static_files(app, config):
 # We connect this function to the step after the builder is initialized
 def setup(app):
 
-    # Updates `master_doc` using the first item of `_toc.yml`
-    app.connect("config-inited", add_toc_to_sphinx)
-
-    # Add toctrees to each content page using `_toc.yml`
-    app.connect("source-read", add_toctree)
-
-    # Path for `_toc.yml`
-    app.add_config_value("globaltoc_path", "toc.yml", "env")
     app.add_config_value("use_jupyterbook_latex", True, "env")
-
     # Add custom static files to the sphinx build
     app.connect("config-inited", add_static_files)
 
-    # Directives
-    app.add_directive("tableofcontents", TableofContents)
-
-    # Transforms
-    app.add_post_transform(SwapTableOfContents)
-
     # Extensions
     return {
         "version": __version__,

jupyter_book/book_template/_toc.yml

@@ -1,6 +1,8 @@
 # Table of contents
 # Learn more at https://jupyterbook.org/customize/toc.html
 
-- file: intro
+format: jb-article
+root: intro
+sections:
 - file: markdown
 - file: notebooks