Skip to content

Build and deploy documentation #7

Build and deploy documentation

Build and deploy documentation #7

Workflow file for this run

# Simple workflow for deploying static content to GitHub Pages
name: Build and deploy documentation
on:
# Runs on pushes targeting the default branch
release:
types: [published]
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false
jobs:
# Single deploy job since we're just deploying
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: 3.11
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Install dependencies
run: |
python3 -m pip install --upgrade pip
python3 -m pip install .[doc_generation]
- name: Install pandoc
uses: pandoc/actions/setup@v1
- name: Build documentation
run: |
cd docs
make html
cd ..
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
# Upload docs dir
path: './docs'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4