Hide Common from toctree

Signed-off-by: Travis F. Collins <[email protected]>
sdgtt · May 15, 2024 · 832a89f · 832a89f
1 parent dc29a65
commit 832a89f
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 5 deletions.
diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml
@@ -154,8 +154,8 @@ jobs:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./doc/build/html
 
-      - name: Publish package
-        uses: pypa/gh-action-pypi-publish@master
-        with:
-          user: __token__
-          password: ${{ secrets.PYPI_TOKEN }}
+      # - name: Publish package
+      #   uses: pypa/gh-action-pypi-publish@master
+      #   with:
+      #     user: __token__
+      #     password: ${{ secrets.PYPI_TOKEN }}
diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -3,3 +3,4 @@ myst-parser
 sphinxcontrib-mermaid
 pillow
 furo
+sphinx-remove-toctrees
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -33,11 +33,13 @@
     "sphinx.ext.githubpages",
     "myst_parser",
     "sphinxcontrib.mermaid",
+    "sphinx_remove_toctrees",
 ]
 
 templates_path = ["_templates"]
 exclude_patterns = []
 
+remove_from_toctrees = ["instruments/bench.common.rst"]
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,3 +3,4 @@ myst-parser @@
     sphinxcontrib-mermaid
     pillow
     furo
+    sphinx-remove-toctrees