From 056d71c6ec72782d17837ca89a0e434c15f2d6b5 Mon Sep 17 00:00:00 2001 From: Vecko <36369090+VeckoTheGecko@users.noreply.github.com> Date: Wed, 24 Jun 2026 13:19:05 +0200 Subject: [PATCH 1/5] Update clean doc building task --- docs/Makefile | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/Makefile b/docs/Makefile index 3bc6174db..6d0ae9a62 100755 --- a/docs/Makefile +++ b/docs/Makefile @@ -51,6 +51,7 @@ help: clean: rm -rf $(BUILDDIR)/* rm -rf .jupyter_cache + rm -f */**/*.parquet html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html From 5f632fda8fc950f309e5871db1935629d1f462c3 Mon Sep 17 00:00:00 2001 From: Vecko <36369090+VeckoTheGecko@users.noreply.github.com> Date: Wed, 24 Jun 2026 14:54:26 +0200 Subject: [PATCH 2/5] Update task runner files --- docs/Makefile | 8 +++++++- pixi.toml | 7 ++++--- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/docs/Makefile b/docs/Makefile index 6d0ae9a62..b8e69b2a8 100755 --- a/docs/Makefile +++ b/docs/Makefile @@ -4,6 +4,7 @@ # You can set these variables from the command line. SPHINXOPTS = SPHINXBUILD = sphinx-build +SPHINXATUOBUILD = sphinx-autobuild PAPER = BUILDDIR = _build @@ -24,6 +25,7 @@ I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . help: @echo "Please use \`make ' where is one of" @echo " html to make standalone HTML files" + @echo " livehtml to make HTML files and serve with rebuilding on a server" @echo " dirhtml to make HTML files named index.html in directories" @echo " singlehtml to make a single large HTML file" @echo " pickle to make pickle files" @@ -51,7 +53,7 @@ help: clean: rm -rf $(BUILDDIR)/* rm -rf .jupyter_cache - rm -f */**/*.parquet + rm -f **/*.parquet html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html @@ -192,3 +194,7 @@ pseudoxml: $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml @echo @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." + +livehtml: + @echo "$(SPHINXATUOBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html" + $(SPHINXATUOBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html diff --git a/pixi.toml b/pixi.toml index a9ecfe973..38b149c8f 100644 --- a/pixi.toml +++ b/pixi.toml @@ -128,9 +128,10 @@ sphinx-design = "*" sphinx-autoapi = "*" [feature.docs.tasks] -docs = { cmd = "sphinx-build docs docs/_build", description = "Build the documentation." } -docs-watch = { cmd = "sphinx-autobuild docs docs/_build", description = "Build and auto-rebuild the documentation on changes." } -docs-linkcheck = { cmd = "sphinx-build -b linkcheck docs/ docs/_build/linkcheck", description = "Verify all links in documentation don't 404." } +docs = { cmd = "make html", cwd = "docs", description = "Build the documentation." } +docs-clean = { cmd = "make clean && make html", cwd = "docs", description = "Build the documentation." } +docs-watch = { cmd = "make livehtml", cwd = "docs", description = "Build and auto-rebuild the documentation on changes." } +docs-linkcheck = { cmd = "make linkcheck", cwd = "docs", description = "Verify all links in documentation don't 404." } [feature.pre-commit.dependencies] pre_commit = "*" From 473958a13956855094320eb3175682f8b82e140a Mon Sep 17 00:00:00 2001 From: Vecko <36369090+VeckoTheGecko@users.noreply.github.com> Date: Wed, 24 Jun 2026 15:42:03 +0200 Subject: [PATCH 3/5] Update .readthedocs config --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index af33c564d..f2d25e607 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -14,6 +14,6 @@ build: build: html: - pixi run -e docs python ci/scripts/download-all-tutorial-datasets.py - - pixi run -e docs sphinx-build -T -b html docs $READTHEDOCS_OUTPUT/html + - SPHINXOPTS='-T' BUILDDIR=$READTHEDOCS_OUTPUT/html pixi run docs-clean sphinx: configuration: docs/conf.py From be37abea09bdc22cb9daefb1844ee4e25a10fb74 Mon Sep 17 00:00:00 2001 From: Vecko <36369090+VeckoTheGecko@users.noreply.github.com> Date: Wed, 24 Jun 2026 16:09:08 +0200 Subject: [PATCH 4/5] Update `make clean` to use `find` the shell used by make doesnt support using ** --- docs/Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Makefile b/docs/Makefile index b8e69b2a8..f27a45506 100755 --- a/docs/Makefile +++ b/docs/Makefile @@ -53,7 +53,7 @@ help: clean: rm -rf $(BUILDDIR)/* rm -rf .jupyter_cache - rm -f **/*.parquet + find . -name "*.parquet" -delete html: $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html From 7438ccdfcf91c795fd735b98b6c2e6a22abf50f6 Mon Sep 17 00:00:00 2001 From: Vecko <36369090+VeckoTheGecko@users.noreply.github.com> Date: Wed, 24 Jun 2026 16:16:52 +0200 Subject: [PATCH 5/5] Add docs-only-clean task --- pixi.toml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/pixi.toml b/pixi.toml index 38b149c8f..097721e61 100644 --- a/pixi.toml +++ b/pixi.toml @@ -128,8 +128,12 @@ sphinx-design = "*" sphinx-autoapi = "*" [feature.docs.tasks] +docs-only-clean = { cmd = "make clean", cwd = "docs", description = "Cleans the documentation folder of build artifacts." } docs = { cmd = "make html", cwd = "docs", description = "Build the documentation." } -docs-clean = { cmd = "make clean && make html", cwd = "docs", description = "Build the documentation." } +docs-clean = { depends-on = [ + { task = "docs-only-clean" }, + { task = "docs" }, +], description = "Build the documentation from a clean docs folder." } docs-watch = { cmd = "make livehtml", cwd = "docs", description = "Build and auto-rebuild the documentation on changes." } docs-linkcheck = { cmd = "make linkcheck", cwd = "docs", description = "Verify all links in documentation don't 404." }