DOC: modernize website API interlinking (#337)

* DOC: add source code link * DOC: add sidebar icons * DOC: switch to API source code link * DX: add `.virtual_documents` to `.gitignore` * ENH: install libraries for type hints * MAINT: ignore false-positive bookfinder.com * MAINT: sort `html_theme_options` * MAINT: update pip constraints and pre-commit --------- Co-authored-by: GitHub <[email protected]> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
ComPWA · Jan 23, 2024 · d2552b9 · d2552b9
1 parent 63105c2
commit d2552b9
Show file tree

Hide file tree

Showing 14 changed files with 133 additions and 389 deletions.
diff --git a/.constraints/py3.10.txt b/.constraints/py3.10.txt
@@ -169,11 +169,13 @@ sniffio==1.3.0
 snowballstemmer==2.2.0
 soupsieve==2.5
 sphinx==7.2.6
+sphinx-api-relink==0.0.8
 sphinx-autobuild==2021.3.14
 sphinx-book-theme==1.1.0
 sphinx-codeautolink==0.15.0
 sphinx-copybutton==0.5.2
 sphinx-design==0.5.0
+sphinx-pybtex-etal-style==0.0.2
 sphinx-reredirects==0.1.3
 sphinx-togglebutton==0.3.2
 sphinxcontrib-applehelp==1.0.8
@@ -199,6 +201,7 @@ tox==4.12.1
 tqdm==4.66.1
 traitlets==5.14.1
 types-python-dateutil==2.8.19.20240106
+types-requests==2.31.0.20240106
 typing-extensions==4.9.0
 tzdata==2023.4
 ujson==5.9.0

diff --git a/.constraints/py3.11.txt b/.constraints/py3.11.txt
@@ -168,11 +168,13 @@ sniffio==1.3.0
 snowballstemmer==2.2.0
 soupsieve==2.5
 sphinx==7.2.6
+sphinx-api-relink==0.0.8
 sphinx-autobuild==2021.3.14
 sphinx-book-theme==1.1.0
 sphinx-codeautolink==0.15.0
 sphinx-copybutton==0.5.2
 sphinx-design==0.5.0
+sphinx-pybtex-etal-style==0.0.2
 sphinx-reredirects==0.1.3
 sphinx-togglebutton==0.3.2
 sphinxcontrib-applehelp==1.0.8
@@ -197,6 +199,7 @@ tox==4.12.1
 tqdm==4.66.1
 traitlets==5.14.1
 types-python-dateutil==2.8.19.20240106
+types-requests==2.31.0.20240106
 typing-extensions==4.9.0
 tzdata==2023.4
 ujson==5.9.0

diff --git a/.constraints/py3.12.txt b/.constraints/py3.12.txt
@@ -168,11 +168,13 @@ sniffio==1.3.0
 snowballstemmer==2.2.0
 soupsieve==2.5
 sphinx==7.2.6
+sphinx-api-relink==0.0.8
 sphinx-autobuild==2021.3.14
 sphinx-book-theme==1.1.0
 sphinx-codeautolink==0.15.0
 sphinx-copybutton==0.5.2
 sphinx-design==0.5.0
+sphinx-pybtex-etal-style==0.0.2
 sphinx-reredirects==0.1.3
 sphinx-togglebutton==0.3.2
 sphinxcontrib-applehelp==1.0.8
@@ -197,6 +199,7 @@ tox==4.12.1
 tqdm==4.66.1
 traitlets==5.14.1
 types-python-dateutil==2.8.19.20240106
+types-requests==2.31.0.20240106
 typing-extensions==4.9.0
 tzdata==2023.4
 ujson==5.9.0

diff --git a/.constraints/py3.8.txt b/.constraints/py3.8.txt
@@ -173,11 +173,13 @@ sniffio==1.3.0
 snowballstemmer==2.2.0
 soupsieve==2.5
 sphinx==5.3.0
+sphinx-api-relink==0.0.8
 sphinx-autobuild==2021.3.14
 sphinx-book-theme==1.0.1
 sphinx-codeautolink==0.15.0
 sphinx-copybutton==0.5.2
 sphinx-design==0.5.0
+sphinx-pybtex-etal-style==0.0.2
 sphinx-reredirects==0.1.3
 sphinx-togglebutton==0.3.2
 sphinxcontrib-applehelp==1.0.4
@@ -203,6 +205,7 @@ tox==4.12.1
 tqdm==4.66.1
 traitlets==5.14.1
 types-python-dateutil==2.8.19.20240106
+types-requests==2.31.0.20240106
 typing-extensions==4.9.0
 tzdata==2023.4
 ujson==5.9.0

diff --git a/.constraints/py3.9.txt b/.constraints/py3.9.txt
@@ -170,11 +170,13 @@ sniffio==1.3.0
 snowballstemmer==2.2.0
 soupsieve==2.5
 sphinx==7.2.6
+sphinx-api-relink==0.0.8
 sphinx-autobuild==2021.3.14
 sphinx-book-theme==1.1.0
 sphinx-codeautolink==0.15.0
 sphinx-copybutton==0.5.2
 sphinx-design==0.5.0
+sphinx-pybtex-etal-style==0.0.2
 sphinx-reredirects==0.1.3
 sphinx-togglebutton==0.3.2
 sphinxcontrib-applehelp==1.0.8
@@ -200,6 +202,7 @@ tox==4.12.1
 tqdm==4.66.1
 traitlets==5.14.1
 types-python-dateutil==2.8.19.20240106
+types-requests==2.31.0.20240106
 typing-extensions==4.9.0
 tzdata==2023.4
 ujson==5.9.0

diff --git a/.gitignore b/.gitignore
@@ -25,6 +25,7 @@ version.py
 .mypy*/
 .pytest_cache/
 .sympy-cache*/
+.virtual_documents/
 __pycache__/
 htmlcov/
 prof/

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