DOC: remove .html from page URLs (#245)

* MAINT: remove redundant templates
ComPWA · Jan 20, 2024 · 5cb791c · 5cb791c
1 parent abff92c
commit 5cb791c
Show file tree

Hide file tree

Showing 8 changed files with 10 additions and 133 deletions.
diff --git a/.cspell.json b/.cspell.json
@@ -21,7 +21,6 @@
   ],
   "ignorePaths": [
     "**/*.bib",
-    "**/*.rst_t",
     "**/.cspell.json",
     ".constraints/*.txt",
     ".editorconfig",
@@ -33,7 +32,6 @@
     ".vscode/*",
     "CITATION.cff",
     "codecov.yml",
-    "docs/_templates/*",
     "docs/conf.py",
     "pyproject.toml",
     "setup.cfg",

diff --git 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/docs/_templates/genindex.html b/docs/_templates/genindex.html
diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html
diff --git a/docs/_templates/module.rst_t b/docs/_templates/module.rst_t
diff --git a/docs/_templates/package.rst_t b/docs/_templates/package.rst_t
diff --git a/docs/_templates/toc.rst_t b/docs/_templates/toc.rst_t
diff --git a/tox.ini b/tox.ini
@@ -34,7 +34,7 @@ commands =
   sphinx-build \
     --keep-going \
     -TW \
-    -b html \
+    -b dirhtml \
     docs/ docs/_build/html
 description =
   Build documentation and API through Sphinx
@@ -64,6 +64,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
@@ -78,7 +79,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
@@ -110,6 +111,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
@@ -123,7 +125,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 = *