CI: publish documentation at https://amaranth-lang.org/docs/amaranth/

.github/workflows/main.yaml

@@ -57,20 +57,22 @@ jobs:
           sphinx-build docs docs/_build
       - name: Publish development documentation
         if: github.event_name == 'push' && github.event.ref == 'refs/heads/main'
-        uses: JamesIves/github-pages-deploy-action@releases/v3
+        uses: JamesIves/github-pages-deploy-action@releases/v4
         with:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          BRANCH: gh-pages
-          FOLDER: docs/_build
-          TARGET_FOLDER: latest/
+          repository-name: amaranth-lang/amaranth-lang.github.io
+          ssh-key: ${{ secrets.PAGES_DEPLOY_KEY }}
+          branch: main
+          folder: docs/_build
+          target-folder: docs/amaranth/latest/
       - name: Extract release version
         if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags/v')
         run: echo "VERSION=$(python setup.py --version)" >>$GITHUB_ENV
       - name: Publish release documentation
         if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags/v')
-        uses: JamesIves/github-pages-deploy-action@releases/v3
+        uses: JamesIves/github-pages-deploy-action@releases/v4
         with:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          BRANCH: gh-pages
-          FOLDER: docs/_build
-          TARGET_FOLDER: v${{ env.VERSION }}/
+          repository-name: amaranth-lang/amaranth-lang.github.io
+          ssh-key: ${{ secrets.PAGES_DEPLOY_KEY }}
+          branch: main
+          folder: docs/_build
+          target-folder: docs/amaranth/v${{ env.VERSION }}/

README.md

@@ -16,11 +16,11 @@ The development of Amaranth has been supported by [SymbioticEDA][], [LambdaConce
 
 ## Introduction
 
-See the [Introduction](https://amaranth-lang.org/amaranth/latest/intro.html) section of the documentation.
+See the [Introduction](https://amaranth-lang.org/docs/amaranth/latest/intro.html) section of the documentation.
 
 ## Installation
 
-See the [Installation](https://amaranth-lang.org/amaranth/latest/install.html) section of the documentation.
+See the [Installation](https://amaranth-lang.org/docs/amaranth/latest/install.html) section of the documentation.
 
 ## Supported devices
 

docs/cover.rst

@@ -5,4 +5,4 @@ Amaranth HDL documentation
    :maxdepth: 1
 
    index
-   Board definitions <https://amaranth-lang.org/amaranth-boards/latest/>
+   Board definitions <https://amaranth-lang.org/docs/amaranth-boards/latest/>

setup.py

@@ -58,7 +58,7 @@ setup(
         ]
     },
     project_urls={
-        "Documentation": "https://amaranth-lang.org/amaranth/{}".format(doc_version()),
+        "Documentation": "https://amaranth-lang.org/docs/amaranth/{}".format(doc_version()),
         "Source Code": "https://github.com/amaranth-lang/amaranth",
         "Bug Tracker": "https://github.com/amaranth-lang/amaranth/issues",
     },