Skip to content

Documentation

Documentation #5

Workflow file for this run

name: Documentation
on:
workflow_run:
workflows: [Release]
types:
- completed
workflow_dispatch:
env:
PIP_NO_OPTION: on
PIP_NO_CLEAN: on
PIP_PREFER_BINARY: on
permissions:
contents: read
pages: write
id-token: write
concurrency:
group: ${{ github.workflow }}
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
timeout-minutes: 10
steps:
- name: Checkout repo
uses: actions/checkout@v4
with:
fetch-depth: 1
- name: Cache requirements
uses: actions/cache@v4
env:
cache-name: cache-requirements
with:
path: ~/.cache/pip
key: ${{ env.cache-name }}-${{ hashFiles('requirements.txt') }}
restore-keys: |
${{ env.cache-name }}-
- name: Cache environment
uses: actions/cache@v4
env:
cache-name: cache-environment
with:
path: ~/.cache/pip
key: ${{ env.cache-name }}-${{ hashFiles('*.lock') }}
restore-keys: |
${{ env.cache-name }}-
- name: Setup python
uses: actions/setup-python@v5
with:
python-version: 3.11
- name: Setup pages
uses: actions/configure-pages@v5
- name: Install requirements
run: make install
- name: Run sphinx
run: make docs
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./docs/dist
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4