usb-tools/amaranth
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

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

Browse source
This commit is contained in:
Catherine 2021-12-16 17:44:02 +00:00
parent a243e0443e
commit e2b3e8caf9
4 changed files with 16 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
.github/workflows/main.yaml vendored
View file

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

4
README.md
View file

@ -16,11 +16,11 @@ The development of Amaranth has been supported by [SymbioticEDA][], [LambdaConce
## Introduction ## 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 ## 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 ## Supported devices

2
docs/cover.rst
View file

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

2
setup.py
View file

@ -58,7 +58,7 @@ setup(
] ]
}, },
project_urls={ 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", "Source Code": "https://github.com/amaranth-lang/amaranth",
"Bug Tracker": "https://github.com/amaranth-lang/amaranth/issues", "Bug Tracker": "https://github.com/amaranth-lang/amaranth/issues",
}, },