From 832a89fcf3b6a9107de129a2478ad858f43f7b47 Mon Sep 17 00:00:00 2001 From: "Travis F. Collins" Date: Wed, 15 May 2024 10:23:19 -0600 Subject: [PATCH] Hide Common from toctree Signed-off-by: Travis F. Collins --- .github/workflows/doc.yml | 10 +++++----- doc/requirements.txt | 1 + doc/source/conf.py | 2 ++ 3 files changed, 8 insertions(+), 5 deletions(-) diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index c53119a..7520bf1 100644 --- 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 index 786c255..7ac8041 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -3,3 +3,4 @@ myst-parser sphinxcontrib-mermaid pillow furo +sphinx-remove-toctrees \ No newline at end of file diff --git a/doc/source/conf.py b/doc/source/conf.py index 1544b9c..8e15500 100644 --- 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