From 4dd80e0ed14cac54b29cf82a0d6294b9ea42c8b1 Mon Sep 17 00:00:00 2001 From: Remco de Boer <29308176+redeboer@users.noreply.github.com> Date: Sat, 20 Jan 2024 23:26:32 +0100 Subject: [PATCH] DOC: remove `.html` from page URLs (#388) --- .readthedocs.yml | 2 +- tox.ini | 12 +++++++++--- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 1362c4ee2..7a3d348d5 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,7 +1,7 @@ version: 2 sphinx: - builder: html + builder: dirhtml configuration: docs/conf.py fail_on_warning: true diff --git a/tox.ini b/tox.ini index c7b0d91ad..eb06d2dc3 100644 --- a/tox.ini +++ b/tox.ini @@ -38,7 +38,7 @@ commands = sphinx-build \ --keep-going \ -TW \ - -b html \ + -b dirhtml \ docs/ docs/_build/html description = Build documentation and API through Sphinx @@ -72,6 +72,7 @@ commands = --re-ignore docs/api/.* \ --watch docs \ --watch src \ + -b dirhtml \ docs/ docs/_build/html description = Set up a server to directly preview changes to the HTML pages @@ -87,7 +88,7 @@ commands = sphinx-build \ --keep-going \ -TW \ - -b html \ + -b dirhtml \ docs/ docs/_build/html description = Build documentation through Sphinx WITH output of Jupyter notebooks @@ -122,6 +123,7 @@ commands = --re-ignore docs/api/.* \ --watch docs \ --watch src \ + -b dirhtml \ docs/ docs/_build/html description = Set up a server to directly preview changes to the HTML pages @@ -135,7 +137,11 @@ setenv = allowlist_externals = sphinx-build commands = - sphinx-build -nW --keep-going -b html docs/ docs/_build/html + sphinx-build \ + --keep-going \ + -b dirhtml \ + -nW \ + docs/ docs/_build/html description = Execute ALL Jupyter notebooks and build documentation with Sphinx passenv = *