Publish documentation #3
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: "Publish documentation" | |
on: | |
push: | |
branches: | |
- master | |
workflow_dispatch: | |
jobs: | |
build: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout | |
uses: actions/checkout@v4 | |
with: | |
persist-credentials: false | |
fetch-depth: 0 | |
- name: Set up Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: '3.12' | |
- name: Install dependencies | |
run: make -C docs setupenv | |
- name: Install Doxygen (optional) | |
run: sudo apt-get update && sudo apt-get install -y doxygen | |
- name: Build docs | |
run: make -C docs dirhtml | |
- name: Prepare artifact | |
run: | | |
tar \ | |
--dereference --hard-dereference \ | |
--directory docs/_build/dirhtml/ \ | |
-cvf ${{ runner.temp }}/artifact.tar \ | |
. | |
- name: Upload artifact | |
uses: actions/[email protected] | |
with: | |
name: github-pages | |
path: ${{ runner.temp }}/artifact.tar | |
retention-days: "1" | |
release: | |
runs-on: ubuntu-latest | |
needs: build | |
permissions: | |
pages: write | |
id-token: write | |
contents: read | |
environment: | |
name: github-pages | |
url: ${{ steps.deployment.outputs.page_url }} | |
steps: | |
- name: Deploy to GitHub Pages | |
id: deployment | |
uses: actions/deploy-pages@v4 |