From be83d6a1fa6818dc4815ad1ce691ec2926ca787a Mon Sep 17 00:00:00 2001 From: Angus Gibson Date: Sun, 15 Oct 2023 10:53:08 +0000 Subject: [PATCH 1/4] Reduce toctree level for notebook galleries --- docs/documented_examples.rst | 1 + docs/tutorials.rst | 1 + 2 files changed, 2 insertions(+) diff --git a/docs/documented_examples.rst b/docs/documented_examples.rst index 93d4b8a6..798a4514 100644 --- a/docs/documented_examples.rst +++ b/docs/documented_examples.rst @@ -5,5 +5,6 @@ Documented Examples :caption: Documented Examples :name: documented-example-gallery :glob: + :maxdepth: 1 DocumentedExamples/* diff --git a/docs/tutorials.rst b/docs/tutorials.rst index 474c628d..0b5ba14d 100644 --- a/docs/tutorials.rst +++ b/docs/tutorials.rst @@ -5,5 +5,6 @@ Tutorials :caption: Tutorials :name: tutorial-gallery :glob: + :maxdepth: 1 Tutorials/* From b43eb7349d6ab5e86df933d966fa0062d79029e4 Mon Sep 17 00:00:00 2001 From: Angus Gibson Date: Sun, 15 Oct 2023 10:57:39 +0000 Subject: [PATCH 2/4] Update sphinx build workflow --- .github/workflows/sphinx.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/sphinx.yml b/.github/workflows/sphinx.yml index 2236c651..6aa29ef6 100644 --- a/.github/workflows/sphinx.yml +++ b/.github/workflows/sphinx.yml @@ -29,4 +29,6 @@ jobs: sudo apt-get install -y pandoc - name: Ensure sphinx builds (warnings allowed) run: | + cp -r DocumentedExamples/ docs/ + cp -r Tutorials/ docs/ make -C docs html O=-n From ee3135d727ee6fe4c88d2827d6285d7f077ff524 Mon Sep 17 00:00:00 2001 From: Angus Gibson Date: Fri, 20 Oct 2023 11:56:48 +1100 Subject: [PATCH 3/4] Try hiding gallery toctree --- docs/documented_examples.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/documented_examples.rst b/docs/documented_examples.rst index 798a4514..421e960b 100644 --- a/docs/documented_examples.rst +++ b/docs/documented_examples.rst @@ -5,6 +5,6 @@ Documented Examples :caption: Documented Examples :name: documented-example-gallery :glob: - :maxdepth: 1 + :hidden: DocumentedExamples/* From 07a08a86476143cf1c24ed0be7d73e47b4bb3737 Mon Sep 17 00:00:00 2001 From: Angus Gibson Date: Fri, 20 Oct 2023 12:19:56 +1100 Subject: [PATCH 4/4] Hide toctree on tutorials --- docs/tutorials.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorials.rst b/docs/tutorials.rst index 0b5ba14d..71c60f97 100644 --- a/docs/tutorials.rst +++ b/docs/tutorials.rst @@ -5,6 +5,6 @@ Tutorials :caption: Tutorials :name: tutorial-gallery :glob: - :maxdepth: 1 + :hidden: Tutorials/*