From d5c38e8410d93bba3c744b1a8c899e75995ee681 Mon Sep 17 00:00:00 2001 From: shimwell Date: Sun, 5 Jan 2025 12:45:16 +0100 Subject: [PATCH 01/12] added linkcheck to url --- .github/workflows/documentation_update.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/documentation_update.yml b/.github/workflows/documentation_update.yml index 8ab8325c..4b088900 100644 --- a/.github/workflows/documentation_update.yml +++ b/.github/workflows/documentation_update.yml @@ -40,6 +40,8 @@ jobs: run: | pip install --upgrade pip pip install .[docs] + - name: Check URL links + run: sphinx linkcheck - name: Sphinx build tagged version if: startsWith(github.ref, 'refs/tags/') run: | From 85e7a344cabe42e8a1ae0ee3ca7f7b8581d201c9 Mon Sep 17 00:00:00 2001 From: shimwell Date: Sun, 5 Jan 2025 13:08:26 +0100 Subject: [PATCH 02/12] using make cmd for linecheck --- .github/workflows/documentation_update.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/documentation_update.yml b/.github/workflows/documentation_update.yml index 4b088900..d7697471 100644 --- a/.github/workflows/documentation_update.yml +++ b/.github/workflows/documentation_update.yml @@ -40,8 +40,8 @@ jobs: run: | pip install --upgrade pip pip install .[docs] - - name: Check URL links - run: sphinx linkcheck + - name: Check URL links in the docs + run: make linkcheck - name: Sphinx build tagged version if: startsWith(github.ref, 'refs/tags/') run: | From e19588366c434c44aea2800c7d9513a7105f6832 Mon Sep 17 00:00:00 2001 From: shimwell Date: Sun, 5 Jan 2025 13:24:09 +0100 Subject: [PATCH 03/12] using make cmd for linecheck --- .github/workflows/documentation_update.yml | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/.github/workflows/documentation_update.yml b/.github/workflows/documentation_update.yml index d7697471..985ba905 100644 --- a/.github/workflows/documentation_update.yml +++ b/.github/workflows/documentation_update.yml @@ -25,7 +25,7 @@ jobs: - name: Install system packages run: | sudo apt-get update -y - sudo apt-get install -y libgl1 libglx-mesa0 libgl1-mesa-dev libglu1-mesa-dev freeglut3-dev libosmesa6 libosmesa6-dev libgles2-mesa-dev libarchive-dev libpangocairo-1.0-0 + sudo apt-get install -y libgl1 libglx-mesa0 libgl1-mesa-dev libglu1-mesa-dev freeglut3-dev libosmesa6 libosmesa6-dev libgles2-mesa-dev libarchive-dev libpangocairo-1.0-0 libopenblas-dev - uses: mamba-org/setup-micromamba@v1 @@ -41,7 +41,9 @@ jobs: pip install --upgrade pip pip install .[docs] - name: Check URL links in the docs - run: make linkcheck + run: | + make linkcheck + sphinx-build -M linkcheck . _build - name: Sphinx build tagged version if: startsWith(github.ref, 'refs/tags/') run: | From d4d05936873dba72abf4f07c7419d1ef65a6aa5e Mon Sep 17 00:00:00 2001 From: shimwell Date: Sun, 5 Jan 2025 14:15:19 +0100 Subject: [PATCH 04/12] make ci and docs yaml similar --- .github/workflows/ci.yml | 4 +-- .github/workflows/documentation_update.yml | 39 +++++++++++----------- 2 files changed, 22 insertions(+), 21 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index fa8e92ae..8cf5920e 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -33,11 +33,11 @@ jobs: cache-environment: true post-cleanup: 'all' - - name: install dependencies run tests + - name: install dependencies shell: bash -el {0} run: | python -m pip install .[tests] - + - name: Test with pytest shell: bash -el {0} run: | diff --git a/.github/workflows/documentation_update.yml b/.github/workflows/documentation_update.yml index 985ba905..5c1fc780 100644 --- a/.github/workflows/documentation_update.yml +++ b/.github/workflows/documentation_update.yml @@ -1,32 +1,31 @@ name: documentation release on: - pull_request: - branches: - - main - push: - branches: - - main - tags: - - '*' + pull_request: + branches: + - main + push: + branches: + - main + tags: + - '*' permissions: contents: write jobs: - testing: + test: name: Documentation runs-on: ubuntu-latest steps: - - name: checkout actions - uses: actions/checkout@v4 - - name: Install system packages run: | sudo apt-get update -y - sudo apt-get install -y libgl1 libglx-mesa0 libgl1-mesa-dev libglu1-mesa-dev freeglut3-dev libosmesa6 libosmesa6-dev libgles2-mesa-dev libarchive-dev libpangocairo-1.0-0 libopenblas-dev + sudo apt-get install -y libgl1 libglx-mesa0 libgl1-mesa-dev libglu1-mesa-dev freeglut3-dev libosmesa6 libosmesa6-dev libgles2-mesa-dev libarchive-dev libpangocairo-1.0-0 + - name: checkout actions + uses: actions/checkout@v4 - uses: mamba-org/setup-micromamba@v1 with: @@ -36,14 +35,14 @@ jobs: cache-environment: true post-cleanup: 'all' - - name: install package + - name: install dependencies + shell: bash -el {0} run: | - pip install --upgrade pip - pip install .[docs] + python -m pip install .[docs] + - name: Check URL links in the docs - run: | - make linkcheck - sphinx-build -M linkcheck . _build + run: sphinx-build -M linkcheck . _build + - name: Sphinx build tagged version if: startsWith(github.ref, 'refs/tags/') run: | @@ -51,12 +50,14 @@ jobs: rm -rf _build/stable mkdir -p _build/stable sphinx-build docs _build/stable + - name: Sphinx build dev version if: (github.event_name == 'push' || github.event_name == 'pull_request') && !startsWith(github.ref, 'refs/tags/') run: | rm -rf _build/dev mkdir -p _build/dev sphinx-build docs _build/dev + - name: Deploy docs to GitHub Pages if: github.event_name == 'push' || startsWith(github.ref, 'refs/tags/') uses: peaceiris/actions-gh-pages@v4 From d35aa9df85a23f1853e9a939c9a0dcd53979c35b Mon Sep 17 00:00:00 2001 From: shimwell Date: Sun, 5 Jan 2025 14:22:00 +0100 Subject: [PATCH 05/12] added shell --- .github/workflows/documentation_update.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/documentation_update.yml b/.github/workflows/documentation_update.yml index 5c1fc780..47629f89 100644 --- a/.github/workflows/documentation_update.yml +++ b/.github/workflows/documentation_update.yml @@ -41,6 +41,7 @@ jobs: python -m pip install .[docs] - name: Check URL links in the docs + shell: bash -el {0} run: sphinx-build -M linkcheck . _build - name: Sphinx build tagged version From 6ce4630473fa53c0763968be0d4e66675e39fdad Mon Sep 17 00:00:00 2001 From: shimwell Date: Sun, 5 Jan 2025 14:28:50 +0100 Subject: [PATCH 06/12] cd docs --- .github/workflows/documentation_update.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/documentation_update.yml b/.github/workflows/documentation_update.yml index 47629f89..e0b4a78f 100644 --- a/.github/workflows/documentation_update.yml +++ b/.github/workflows/documentation_update.yml @@ -42,7 +42,9 @@ jobs: - name: Check URL links in the docs shell: bash -el {0} - run: sphinx-build -M linkcheck . _build + run: | + cd docs + make linkcheck - name: Sphinx build tagged version if: startsWith(github.ref, 'refs/tags/') From a4192acac966f051d53140d7fdc2bff5faf2fffb Mon Sep 17 00:00:00 2001 From: shimwell Date: Sun, 5 Jan 2025 14:33:34 +0100 Subject: [PATCH 07/12] added lincheck inline --- .github/workflows/documentation_update.yml | 10 ++-------- 1 file changed, 2 insertions(+), 8 deletions(-) diff --git a/.github/workflows/documentation_update.yml b/.github/workflows/documentation_update.yml index e0b4a78f..3cc1df72 100644 --- a/.github/workflows/documentation_update.yml +++ b/.github/workflows/documentation_update.yml @@ -40,26 +40,20 @@ jobs: run: | python -m pip install .[docs] - - name: Check URL links in the docs - shell: bash -el {0} - run: | - cd docs - make linkcheck - - name: Sphinx build tagged version if: startsWith(github.ref, 'refs/tags/') run: | sphinx-build docs _build/${{ github.ref_name }} rm -rf _build/stable mkdir -p _build/stable - sphinx-build docs _build/stable + sphinx-build linkcheck docs _build/stable - name: Sphinx build dev version if: (github.event_name == 'push' || github.event_name == 'pull_request') && !startsWith(github.ref, 'refs/tags/') run: | rm -rf _build/dev mkdir -p _build/dev - sphinx-build docs _build/dev + sphinx-build linkcheck docs _build/dev - name: Deploy docs to GitHub Pages if: github.event_name == 'push' || startsWith(github.ref, 'refs/tags/') From d621add4f0827fac9d57ec99747c2c42a6201661 Mon Sep 17 00:00:00 2001 From: shimwell Date: Sun, 5 Jan 2025 14:36:41 +0100 Subject: [PATCH 08/12] added shell --- .github/workflows/ci.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 8cf5920e..bead8840 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -35,8 +35,7 @@ jobs: - name: install dependencies shell: bash -el {0} - run: | - python -m pip install .[tests] + run: python -m pip install .[tests] - name: Test with pytest shell: bash -el {0} From f61d3a74c4cae1cef1a5d20cf47270e41590ef92 Mon Sep 17 00:00:00 2001 From: shimwell Date: Sun, 5 Jan 2025 14:39:15 +0100 Subject: [PATCH 09/12] added shell --- .github/workflows/documentation_update.yml | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/.github/workflows/documentation_update.yml b/.github/workflows/documentation_update.yml index 3cc1df72..dc5cd4fb 100644 --- a/.github/workflows/documentation_update.yml +++ b/.github/workflows/documentation_update.yml @@ -37,19 +37,20 @@ jobs: - name: install dependencies shell: bash -el {0} - run: | - python -m pip install .[docs] - + run: python -m pip install .[docs] + - name: Sphinx build tagged version if: startsWith(github.ref, 'refs/tags/') + shell: bash -el {0} run: | sphinx-build docs _build/${{ github.ref_name }} rm -rf _build/stable mkdir -p _build/stable sphinx-build linkcheck docs _build/stable - + - name: Sphinx build dev version if: (github.event_name == 'push' || github.event_name == 'pull_request') && !startsWith(github.ref, 'refs/tags/') + shell: bash -el {0} run: | rm -rf _build/dev mkdir -p _build/dev From a9251d36c3f86fca68dd1e05db399bb9f9221be4 Mon Sep 17 00:00:00 2001 From: Jonathan Shimwell Date: Sun, 5 Jan 2025 15:11:27 +0100 Subject: [PATCH 10/12] added -b --- .github/workflows/documentation_update.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/documentation_update.yml b/.github/workflows/documentation_update.yml index dc5cd4fb..b502bf60 100644 --- a/.github/workflows/documentation_update.yml +++ b/.github/workflows/documentation_update.yml @@ -46,7 +46,7 @@ jobs: sphinx-build docs _build/${{ github.ref_name }} rm -rf _build/stable mkdir -p _build/stable - sphinx-build linkcheck docs _build/stable + sphinx-build -b linkcheck docs _build/stable - name: Sphinx build dev version if: (github.event_name == 'push' || github.event_name == 'pull_request') && !startsWith(github.ref, 'refs/tags/') @@ -54,7 +54,7 @@ jobs: run: | rm -rf _build/dev mkdir -p _build/dev - sphinx-build linkcheck docs _build/dev + sphinx-build -b linkcheck docs _build/dev - name: Deploy docs to GitHub Pages if: github.event_name == 'push' || startsWith(github.ref, 'refs/tags/') From 22a1a45f3215125de7fe4aff8e3986b01a21e8f3 Mon Sep 17 00:00:00 2001 From: Jonathan Shimwell Date: Sun, 5 Jan 2025 15:30:10 +0100 Subject: [PATCH 11/12] break url to test linkcheck --- docs/install.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/install.rst b/docs/install.rst index 06880bec..05650476 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -1,7 +1,7 @@ Install ======= -Paramak is distributed via `PyPI `_ and can be installed using pip. +Paramak is distributed via `PyPI `_ and can be installed using pip. .. code-block:: bash From ad374da95c907eba26b1e73c3faf30d713e944a4 Mon Sep 17 00:00:00 2001 From: Jonathan Shimwell Date: Sun, 5 Jan 2025 15:48:46 +0100 Subject: [PATCH 12/12] reverted broken link test --- docs/install.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/install.rst b/docs/install.rst index 05650476..06880bec 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -1,7 +1,7 @@ Install ======= -Paramak is distributed via `PyPI `_ and can be installed using pip. +Paramak is distributed via `PyPI `_ and can be installed using pip. .. code-block:: bash