Merge pull request #328 from bsipocz/HTML_TOC_structure

HTML: adding TOC structure to sidebar
nasa-fornax · Aug 30, 2024 · 235d6bd · 235d6bd
2 parents d406fe7 + 7a58d1b
commit 235d6bd
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/index.md b/index.md
@@ -9,6 +9,7 @@ brings together data, software, and computing so that researchers can focus on s
 ```{toctree}
 ---
 maxdepth: 2
+caption: Tutorial Notebooks
 ---
 
 forced_photometry/README
@@ -21,6 +22,7 @@ light_curves/README
 ```{toctree}
 ---
 maxdepth: 2
+caption: User Documentation
 ---
 
 documentation/README

diff --git a/tox.ini b/tox.ini
@@ -17,11 +17,15 @@ deps =
 allowlist_externals =
     bash
     git
+    sed
 
 commands =
     pip freeze
 
     buildhtml: git clone --depth 1 https://github.com/nasa-fornax/fornax-documentation.git documentation
     buildhtml: sphinx-build -b html . _build/html -D nb_execution_mode=off -nT --keep-going
+    # SED magic to remove the toctree captions from the rendered index page while keeping them in the sidebar TOC
+    buildhtml: sed -E -i.bak '/caption-text/{N; s/.+caption-text.+\n<ul>/<ul>/; P;D;}' _build/html/index.html
+    buildhtml: bash -c 'rm _build/html/index.html.bak'
 
 skip_install = true