Skip to content

Publish documentation to GitHub Pages #1

Publish documentation to GitHub Pages

Publish documentation to GitHub Pages #1

Workflow file for this run

name: Publish documentation to GitHub Pages
on:
release:
types: [created]
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Python 3.8
uses: actions/setup-python@v5
with:
python-version: "3.8"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements.txt
pip install -r docs/requirements.txt
- name: Build documentation
run: cd docs && make html
- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v3
with:
path: './docs/build/html'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4