Skip to content

Documentation

Documentation #4

Workflow file for this run

name: Documentation
on:
workflow_dispatch:
inputs:
version:
description: A documentation version to deploy (refs/tags/... or commit).
required: true
type: string
concurrency:
group: ${{ github.ref }}
cancel-in-progress: true
# Allow reading repository contents and publishing to Github Pages.
permissions:
pages: write
contents: read
id-token: write
jobs:
publish:
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Checkout specified version
uses: actions/checkout@v3
with:
ref: ${{ inputs.version }}
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.9'
- name: Install dependencies
run: python -m pip install --upgrade pip setuptools wheel twine
- name: Install development tools
run: pip install .[tests]
- name: Generate documentation
run: make documentation
- name: Setup Github Pages
uses: actions/configure-pages@v2
- name: Upload documentation artifact
uses: actions/upload-pages-artifact@v1
with:
path: docs/_generated/
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1