Skip to content

Publish doc to GitHub Pages #92

Publish doc to GitHub Pages

Publish doc to GitHub Pages #92

Workflow file for this run

name: Documentation
on:
push:
pull_request:
workflow_dispatch: # Allows you to run this workflow manually from the Actions tab
# 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:
build:
name: Build documentation & check links
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/[email protected]
with:
python-version: "3.11"
- run: |
pip install --constraint=.github/workflows/constraints.txt pip
pip install --constraint=.github/workflows/constraints.txt nox
- name: Build documentation
run: nox --force-color --session=docs
- uses: actions/upload-artifact@v3
with:
path: docs/_build
- name: Check links
run: nox --force-color --session=linkcheck
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
permissions:
contents: read
pages: write
id-token: write
runs-on: ubuntu-latest
needs: build
steps:
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2