Use GitHub pages (#117)

* Add support for tags in build workflow and fix
regex in conf.py

* Restructure build workflow to use github-pages

* Fix syntax error in build.yaml

* Add fetch-depth to checkout step in build.yaml

* Fix fetch-depth in build.yaml

* Fix variable assignment in build.yaml

* Fix variable assignment in build.yaml.

* Refactor build.yaml to simplify tag finding

* Update conda activation command to use microconda

* Update link-check job to use last tagged version
instead of official

Author: melund

.github/workflows/build.yaml

@@ -4,6 +4,7 @@ name: Build Tutorials
 on:
   push:
     branches: [ master ]
+    tags: ["*"]
   pull_request:
     branches: [ master ]
   workflow_dispatch:
@@ -20,66 +21,108 @@ defaults:
 
 jobs:
 
-  build-official-version:
-
+  find-tag:
     runs-on: ubuntu-latest
-
+    outputs:
+      latest-tag: ${{ steps.find-tag.outputs.tag }}
     steps:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-    
-      - name: Checkout last tagged
-        run: |
-          git checkout $(git describe --tags `git rev-list --tags --max-count=1`);
+      
+      - id: find-tag
+        run: echo "tag=$(git describe --tags `git rev-list --tags --max-count=1`)" >> "$GITHUB_OUTPUT"
 
+
+  link-check:
+
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      
       - name: Install mamba
         uses: mamba-org/setup-micromamba@v1
         with:
           environment-file: environment.yaml
-  
-      - name: Build last tagged version
-        run: |
-          make clean
-          make html O="-W"
 
-      - name: Check links
-        run: sphinx-build -M linkcheck . _build -W --keep-going -a -q 
+      - run: sphinx-build -M linkcheck . _build -W --keep-going -a -q 
+      
+
+  link-check-last-tagged:
 
-      - name: Deploy 🚀
-        if: github.event.inputs.run_deploy
-        uses: peaceiris/actions-gh-pages@v3
+    runs-on: ubuntu-latest
+    needs: find-tag
+    steps:
+      - uses: actions/checkout@v4
         with:
-          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
-          external_repository: AnyBody/tutorials
-          publish_branch: gh-pages
-          publish_dir: _build/html
+          ref: ${{ needs.find-tag.outputs.latest-tag }}
+      
+      - name: Install mamba
+        uses: mamba-org/setup-micromamba@v1
+        with:
+          environment-file: environment.yaml
 
+      - run: sphinx-build -M linkcheck . _build -W --keep-going -a -q 
+          
+    
+  build:
 
-  sphinx-build:
     runs-on: ubuntu-latest
+    needs: [find-tag, link-check]
+
     steps:
       - uses: actions/checkout@v4
-       
+        with:
+          fetch-depth: 0
+    
       - name: Install mamba
         uses: mamba-org/setup-micromamba@v1
         with:
           environment-file: environment.yaml
-    
+
       - name: Build Documentation
-        run:  make html O="-W"
+        run:  |
+          sphinx-build -M html . _build-beta -W --keep-going -a -t draft
+    
+      - name: Checkout last tagged
+        run: |
+          git checkout ${{ needs.find-tag.outputs.latest-tag }}
 
-      - name: Check links
-        run: sphinx-build -M linkcheck . _build -W --keep-going -a -q 
+      - name: Build environment for last tagged version
+        run: micromamba create -n tutorial-tagged -y -f environment.yaml
 
-      - name: Deploy 🚀
-        uses: peaceiris/actions-gh-pages@v3
-        if: github.ref == 'refs/heads/master'
-        with:
-          deploy_key: ${{ secrets.ACTIONS_DEPLOY_KEY }}
-          external_repository: AnyBody/tutorials
-          publish_branch: gh-pages
-          publish_dir: _build/html
-          destination_dir: dev
+      - name: Build last tagged version
+        run: |
+          micromamba activate tutorial-tagged
+          sphinx-build -M html . _build -W --keep-going -a
+
+      - name: Prepare html for upload
+        run: | 
+          mkdir -p gh-pages/beta
+          cp -rT _build-beta/html gh-pages/beta
+          cp -rT _build/html gh-pages
+
+      - uses: actions/upload-pages-artifact@v2
+        with: 
+          path: gh-pages
 
 
+  deploy:
+    needs: build
+    if: github.ref == 'refs/heads/master'
+    runs-on: ubuntu-latest
+    permissions:
+      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@v2
+                  
+        
+

conf.py

@@ -129,14 +129,14 @@ def tagged_commit():
 current_year = os.environ.get("YEAR", datetime.now().year)
 
 ams_version = os.environ.get("AMS_VERSION", "7.4.3")
-if not re.match("^\d\.\d\.\d", ams_version):
+if not re.match(r"^\d\.\d\.\d", ams_version):
     raise ValueError("Wrong format for AMS version, environment variable")
 ams_version_short = ams_version.rpartition(".")[0]
 ams_version_x = ams_version_short + ".x"
 
 
 ammr_version = os.environ.get("AMMR_VERSION", "2.4.3")
-if not re.match("^\d\.\d\.\d", ammr_version):
+if not re.match(r"^\d\.\d\.\d", ammr_version):
     raise ValueError("Wrong format for AMMR version, environment variable")
 ammr_version_short = ammr_version.rpartition(".")[0]
 
@@ -172,7 +172,7 @@ def tagged_commit():
 }
 
 
-no_index = """
+no_index = r"""
 .. meta::
    :name=robots content=noindex: \ 
 """
@@ -448,10 +448,11 @@ def tagged_commit():
 ]
 
 linkcheck_allowed_redirects = {
-    r"https://doi\.org.*": ".*",
+    "https://doi.org.*": ".*",
+    "https://dx.doi.org.*": ".*",
     r"https://www\.sphinx-doc\.org/": r"https://www\.sphinx-doc\.org/en/master/",
     r"https://www\.anybodytech\.com/anybody\.html\?fwd=.*": ".*",
-    r"https://www\.youtube.com/.*": "https://consent\.youtube.com/.*",
+    r"https://www\.youtube.com/.*": r"https://consent\.youtube.com/.*",
 }