From 3e7ac80b6982e453264e245bf8616b46a59116ea Mon Sep 17 00:00:00 2001 From: Remco de Boer <29308176+redeboer@users.noreply.github.com> Date: Sat, 20 Jan 2024 20:40:13 +0100 Subject: [PATCH 1/3] Revert "DOC!: remove `.html` from page URLs" --- .readthedocs.yml | 2 +- CONTRIBUTING.md | 4 +++- tox.ini | 13 +++---------- 3 files changed, 7 insertions(+), 12 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 4410dda9..65d8d11a 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -1,7 +1,7 @@ version: 2 sphinx: - builder: dirhtml + builder: html configuration: docs/conf.py fail_on_warning: true diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4e8ebcdc..9368b24e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,4 +3,6 @@ [![Open in Visual Studio Code](https://img.shields.io/badge/vscode-open-blue?logo=visualstudiocode)](https://open.vscode.dev/ComPWA/compwa.github.io) [![GitPod](https://img.shields.io/badge/gitpod-open-blue?logo=gitpod)](https://gitpod.io/#https://github.com/ComPWA/compwa.github.io) -This repository is part of the [ComPWA Organization](https://github.com/ComPWA). For more information about how to contribute to the packages, go to **[compwa.github.io/develop](https://compwa.github.io/develop)**! +This repository is part of the [ComPWA Organization](https://github.com/ComPWA). For +more information about how to contribute to the packages, go to +[pwa.rtfd.io/develop.html](https://pwa.readthedocs.io/develop.html)! diff --git a/tox.ini b/tox.ini index 88fa912c..fcfb17ea 100644 --- a/tox.ini +++ b/tox.ini @@ -14,7 +14,7 @@ commands = --color \ --keep-going \ -TW \ - -b dirhtml \ + -b html \ docs/ docs/_build/html description = Build documentation and API through Sphinx @@ -43,7 +43,6 @@ commands = --re-ignore docs/.*\.yml \ --re-ignore docs/_build/.* \ --watch docs \ - -b dirhtml \ docs/ docs/_build/html description = Set up a server to directly preview changes to the HTML pages @@ -59,7 +58,7 @@ commands = --color \ --keep-going \ -TW \ - -b dirhtml \ + -b html \ docs/ docs/_build/html description = Build documentation through Sphinx WITH output of Jupyter notebooks @@ -89,7 +88,6 @@ commands = --re-ignore docs/.*\.yml \ --re-ignore docs/_build/.* \ --watch docs \ - -b dirhtml \ docs/ docs/_build/html description = Set up a server to directly preview changes to the HTML pages @@ -102,12 +100,7 @@ setenv = allowlist_externals = sphinx-build commands = - sphinx-build \ - --color \ - --keep-going \ - -b dirhtml \ - -nW \ - docs/ docs/_build/html + sphinx-build -nW --keep-going -b html docs/ docs/_build/html description = Execute ALL Jupyter notebooks and build documentation with Sphinx passenv = * From af695f44d4cdc70d04cfb58845f1f5ca1105b6e9 Mon Sep 17 00:00:00 2001 From: Remco de Boer <29308176+redeboer@users.noreply.github.com> Date: Sat, 20 Jan 2024 20:43:45 +0100 Subject: [PATCH 2/3] FIX: keep changes to `CONTRIBUTING.md` --- CONTRIBUTING.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9368b24e..4e8ebcdc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,6 +3,4 @@ [![Open in Visual Studio Code](https://img.shields.io/badge/vscode-open-blue?logo=visualstudiocode)](https://open.vscode.dev/ComPWA/compwa.github.io) [![GitPod](https://img.shields.io/badge/gitpod-open-blue?logo=gitpod)](https://gitpod.io/#https://github.com/ComPWA/compwa.github.io) -This repository is part of the [ComPWA Organization](https://github.com/ComPWA). For -more information about how to contribute to the packages, go to -[pwa.rtfd.io/develop.html](https://pwa.readthedocs.io/develop.html)! +This repository is part of the [ComPWA Organization](https://github.com/ComPWA). For more information about how to contribute to the packages, go to **[compwa.github.io/develop](https://compwa.github.io/develop)**! From d4541c1b83cd431cdc0bcf2baf310a21acbf46f6 Mon Sep 17 00:00:00 2001 From: Remco de Boer <29308176+redeboer@users.noreply.github.com> Date: Sat, 20 Jan 2024 20:56:25 +0100 Subject: [PATCH 3/3] FIX: use relative link in notebook --- docs/report/015.ipynb | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/docs/report/015.ipynb b/docs/report/015.ipynb index f4753b7b..95abafab 100644 --- a/docs/report/015.ipynb +++ b/docs/report/015.ipynb @@ -1379,9 +1379,7 @@ "metadata": {}, "source": [ ":::{tip}\n", - "\n", - "A test with a larger data distribution is being developed in [TR-013](https://compwa.github.io/report/013.html).\n", - "\n", + "A test with a larger data distribution is being developed in [TR-013](./013.ipynb).\n", ":::" ] },