From 176f4e62d1997934915fc034d40c408b6a60b18f Mon Sep 17 00:00:00 2001 From: "Alexander V. Hopp" Date: Tue, 14 May 2024 17:40:01 +0200 Subject: [PATCH 01/11] Adjust doc building workflow for multi version --- .github/workflows/docs.yml | 53 ++++++++++++++++++++++++-------------- 1 file changed, 33 insertions(+), 20 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index bc7b0b18a..398159b0e 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -24,7 +24,7 @@ jobs: build: runs-on: ubuntu-latest permissions: - contents: read + contents: write pages: write id-token: write steps: @@ -37,22 +37,35 @@ jobs: run: pip install tox-uv - name: Build Docs ${{ inputs.force == true && '(Force)' || '' }} run: tox -e docs-py310 ${{ inputs.force == true && '-- -f -r' || '-- -r' }} - - name: Upload docs artifact - uses: actions/upload-pages-artifact@v1 - with: - path: 'docs/build' - - deploy: - needs: build - runs-on: ubuntu-latest - permissions: - contents: read - pages: write - id-token: write - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} - steps: - - name: Deploy to GitHub Pages - id: deployment - uses: actions/deploy-pages@v1 + - name: Prepare gh-pages branch with HTML output from Sphinx + run: | + git fetch origin gh-pages:gh-pages + git checkout gh-pages + if ${{ github.event_name == 'workflow_dispatch'}}; then + echo "Triggered by workflow_dispatch" + FOLDER='latest' + else + echo "Triggered by release" + FOLDER=${{github.event.release.tag_name}} + fi + echo "$FOLDER" + if [-d $FOLDER]; then + rm -rf ./$FOLDER + fi + mkdir ./$FOLDER + cp -rv docs/build/* ./$FOLDER + - name: Update gh-pages branch + run: | + if ${{ github.event_name == 'workflow_dispatch'}}; then + echo "Triggered by workflow_dispatch" + FOLDER='latest' + else + echo "Triggered by release" + FOLDER=${{github.event.release.tag_name}} + fi + git config --local user.email "sphinx-upload[bot]@users.noreply.github.com" + git config --local user.name "sphinx-upload[bot]" + git_hash=$(git rev-parse --short "$GITHUB_SHA") + git add -f $FOLDER + git commit --allow-empty -m "Sphinx documentation for ${git_hash}" + git push origin gh-pages From aa3b1c1220b67cfcda0e18accc0e11b95972d2b3 Mon Sep 17 00:00:00 2001 From: "Alexander V. Hopp" Date: Fri, 24 May 2024 15:45:59 +0200 Subject: [PATCH 02/11] Add symlink to newest version --- .github/workflows/docs.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 398159b0e..c090c4e2f 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -68,4 +68,8 @@ jobs: git_hash=$(git rev-parse --short "$GITHUB_SHA") git add -f $FOLDER git commit --allow-empty -m "Sphinx documentation for ${git_hash}" + echo "Redirecting stable to newly released version" + ln -sf $FOLDER stable + git add stable + git commit -m "redirect stable to new version $FOLDER" git push origin gh-pages From 9ce27305054343d55543b38e78caaa5eee3a03cb Mon Sep 17 00:00:00 2001 From: "Alexander V. Hopp" Date: Tue, 9 Jul 2024 13:31:36 +0200 Subject: [PATCH 03/11] Add dummy version selector --- docs/index.md | 1 + docs/versions/versions.md | 5 +++++ 2 files changed, 6 insertions(+) create mode 100644 docs/versions/versions.md diff --git a/docs/index.md b/docs/index.md index 1ae69d6ed..d43d3f34e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -34,6 +34,7 @@ License User Guide Examples +Versions ``` # Indices and Tables diff --git a/docs/versions/versions.md b/docs/versions/versions.md new file mode 100644 index 000000000..3a81d4e1e --- /dev/null +++ b/docs/versions/versions.md @@ -0,0 +1,5 @@ +# Versions + +```{toctree} +Stable +``` \ No newline at end of file From e12898ecd73c32e5428c14c0f857a8898414a248 Mon Sep 17 00:00:00 2001 From: "Alexander V. Hopp" Date: Tue, 9 Jul 2024 15:13:27 +0200 Subject: [PATCH 04/11] Add missing blanks in conditional statement --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index c090c4e2f..228a9bcd4 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -49,7 +49,7 @@ jobs: FOLDER=${{github.event.release.tag_name}} fi echo "$FOLDER" - if [-d $FOLDER]; then + if [ -d $FOLDER ]; then rm -rf ./$FOLDER fi mkdir ./$FOLDER From 818d4fa1f172ee4cb49d67b50454315d767ac1f1 Mon Sep 17 00:00:00 2001 From: "Alexander V. Hopp" Date: Tue, 9 Jul 2024 16:13:23 +0200 Subject: [PATCH 05/11] Add stuff for more verbose output --- .github/workflows/docs.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 228a9bcd4..28ad12aba 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -68,7 +68,8 @@ jobs: git_hash=$(git rev-parse --short "$GITHUB_SHA") git add -f $FOLDER git commit --allow-empty -m "Sphinx documentation for ${git_hash}" - echo "Redirecting stable to newly released version" + echo "Redirecting stable to newly released version" + rm stable ln -sf $FOLDER stable git add stable git commit -m "redirect stable to new version $FOLDER" From d9f7250f39281755124f368023fc973ea5ad5e9f Mon Sep 17 00:00:00 2001 From: "Alexander V. Hopp" Date: Tue, 9 Jul 2024 17:14:51 +0200 Subject: [PATCH 06/11] Playing around with the stable link... --- .github/workflows/docs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 28ad12aba..302bc9c69 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -69,8 +69,8 @@ jobs: git add -f $FOLDER git commit --allow-empty -m "Sphinx documentation for ${git_hash}" echo "Redirecting stable to newly released version" - rm stable - ln -sf $FOLDER stable + rm -rf ./stable + ln -s $RELEASE_VERSION stable git add stable git commit -m "redirect stable to new version $FOLDER" git push origin gh-pages From 1b3e68bf0a32105965f4ecc16877049b67e6334b Mon Sep 17 00:00:00 2001 From: "Alexander V. Hopp" Date: Wed, 10 Jul 2024 07:34:44 +0200 Subject: [PATCH 07/11] Allow empty commit for symlink createion --- .github/workflows/docs.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 302bc9c69..58ba55277 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -69,8 +69,8 @@ jobs: git add -f $FOLDER git commit --allow-empty -m "Sphinx documentation for ${git_hash}" echo "Redirecting stable to newly released version" - rm -rf ./stable - ln -s $RELEASE_VERSION stable + rm stable + ln -sf $RELEASE_VERSION stable git add stable - git commit -m "redirect stable to new version $FOLDER" + git commit --allow-empty -m "redirect stable to new version $FOLDER" git push origin gh-pages From b5edbf0e0b07c4827d2ce8a90544ba86b839f2e3 Mon Sep 17 00:00:00 2001 From: "Alexander V. Hopp" Date: Wed, 10 Jul 2024 07:48:32 +0200 Subject: [PATCH 08/11] FIx error in symlink creation --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 58ba55277..085cf66f3 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -70,7 +70,7 @@ jobs: git commit --allow-empty -m "Sphinx documentation for ${git_hash}" echo "Redirecting stable to newly released version" rm stable - ln -sf $RELEASE_VERSION stable + ln -sf $FOLDER stable git add stable git commit --allow-empty -m "redirect stable to new version $FOLDER" git push origin gh-pages From 13fdb00c4fcad8cb43e09675bab913c312f5d509 Mon Sep 17 00:00:00 2001 From: "Alexander V. Hopp" Date: Wed, 10 Jul 2024 13:56:19 +0200 Subject: [PATCH 09/11] Attempt of creating the banner inclusion --- .github/workflows/docs.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 085cf66f3..e8f8f2358 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -73,4 +73,8 @@ jobs: ln -sf $FOLDER stable git add stable git commit --allow-empty -m "redirect stable to new version $FOLDER" + echo "Inserting announcement banner to old documentation" + folder_names=$(find . -maxdepth 1 -type d -regex '\./[0-9].*') + python insert_banner.py "$folder_names" + git add . git push origin gh-pages From d55477fd474274c0d037e3ebbfa241a334ad70d1 Mon Sep 17 00:00:00 2001 From: "Alexander V. Hopp" Date: Wed, 10 Jul 2024 15:36:30 +0200 Subject: [PATCH 10/11] Adjust workflow for adding annoucement banner --- .github/workflows/docs.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index e8f8f2358..6cc9db79f 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -77,4 +77,5 @@ jobs: folder_names=$(find . -maxdepth 1 -type d -regex '\./[0-9].*') python insert_banner.py "$folder_names" git add . + git commit -m "Add announcement banner to old version" git push origin gh-pages From 0f0bb62889fd673be06ba71b2b1aac7230c539de Mon Sep 17 00:00:00 2001 From: "Alexander V. Hopp" Date: Wed, 10 Jul 2024 16:12:23 +0200 Subject: [PATCH 11/11] Add now outdated version --- docs/versions/versions.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/versions/versions.md b/docs/versions/versions.md index 3a81d4e1e..a381c31be 100644 --- a/docs/versions/versions.md +++ b/docs/versions/versions.md @@ -2,4 +2,5 @@ ```{toctree} Stable +0.9.1 ``` \ No newline at end of file