🔍 Show more levels for the in-page table of contents (#36)

Making it easier to navigate to the desired subsections, especially on the API reference page. * 🔍 Add table of contents to top of API reference page Make it easier to jump to the relevant sections, since the list of DataPipes is increasing! * 📝 Order DataPipe subsections on API page alphabetically Swapping positions of Pyogrio and Rioxarray datapipes. * ⚡ Cache execution outputs when building jupyter book docs No need to build pages again if things haven't changed, see https://jupyterbook.org/en/latest/content/execute.html. * 👽 Increase depth of secondary sidebar on the right from 2 to 3 Found the right sphinx-book-theme config setting to increase the depth of the secondary sidebar (on the right) from 2 to 3. See https://sphinx-book-theme.readthedocs.io/en/stable/customize/sidebar-secondary.html. Decided too that the in-page table of contents can go.
weiji14 · Aug 14, 2022 · 62b86a9 · 62b86a9
1 parent 675ad67
commit 62b86a9
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 9 deletions.
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -7,7 +7,7 @@ author: The zen3geo Team
 # Force re-execution of notebooks on each build.
 # See https://jupyterbook.org/content/execute.html
 execute:
-  execute_notebooks: force
+  execute_notebooks: cache
 
 # Define the name of the latex output file for PDF builds
 latex:
@@ -31,6 +31,9 @@ sphinx:
   config:
     autodoc_typehints: 'description'
     html_show_copyright: false
+    html_theme_options:
+      # https://sphinx-book-theme.readthedocs.io/en/stable/customize/sidebar-secondary.html
+      show_toc_level: 3
     intersphinx_mapping:
       datashader:
         - 'https://datashader.org/'

diff --git a/docs/api.md b/docs/api.md
@@ -18,21 +18,21 @@
     :show-inheritance:
 ```
 
-### Rioxarray
+### Pyogrio
 
 ```{eval-rst}
-.. automodule:: zen3geo.datapipes.rioxarray
-.. autoclass:: zen3geo.datapipes.RioXarrayReader
-.. autoclass:: zen3geo.datapipes.rioxarray.RioXarrayReaderIterDataPipe
+.. automodule:: zen3geo.datapipes.pyogrio
+.. autoclass:: zen3geo.datapipes.PyogrioReader
+.. autoclass:: zen3geo.datapipes.pyogrio.PyogrioReaderIterDataPipe
     :show-inheritance:
 ```
 
-### Pyogrio
+### Rioxarray
 
 ```{eval-rst}
-.. automodule:: zen3geo.datapipes.pyogrio
-.. autoclass:: zen3geo.datapipes.PyogrioReader
-.. autoclass:: zen3geo.datapipes.pyogrio.PyogrioReaderIterDataPipe
+.. automodule:: zen3geo.datapipes.rioxarray
+.. autoclass:: zen3geo.datapipes.RioXarrayReader
+.. autoclass:: zen3geo.datapipes.rioxarray.RioXarrayReaderIterDataPipe
     :show-inheritance:
 ```