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

* MAINT: remove redundant templates
ComPWA · Jan 20, 2024 · 4fe7b70 · 4fe7b70
1 parent d03d97c
commit 4fe7b70
Show file tree

Hide file tree

Showing 8 changed files with 5 additions and 132 deletions.
diff --git a/.cspell.json b/.cspell.json
@@ -20,7 +20,6 @@
     "transisions"
   ],
   "ignorePaths": [
-    "**/*.rst_t",
     "**/.cspell.json",
     ".constraints/*.txt",
     ".editorconfig",
@@ -32,7 +31,6 @@
     ".vscode/*",
     "CITATION.cff",
     "codecov.yml",
-    "docs/_templates/*",
     "docs/conf.py",
     "pyproject.toml",
     "tox.ini",

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
@@ -51,7 +51,7 @@ commands =
   sphinx-build \
     --keep-going \
     -TW \
-    -b html \
+    -b dirhtml \
     docs/ docs/_build/html
 description =
   Build documentation and API through Sphinx
@@ -83,6 +83,7 @@ commands =
     --re-ignore docs/usage/sub_expr_f? \
     --watch docs \
     --watch src \
+    -b dirhtml \
     docs/ docs/_build/html
 description =
   Set up a server to directly preview changes to the HTML pages
@@ -97,7 +98,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
@@ -130,6 +131,7 @@ commands =
     --re-ignore docs/usage/sub_expr_f? \
     --watch docs \
     --watch src \
+    -b dirhtml \
     docs/ docs/_build/html
 description =
   Set up a server to directly preview changes to the HTML pages