Skip to content

Prep for building documentation #1

Prep for building documentation

Prep for building documentation #1

Workflow file for this run

name: Pages
on: push
jobs:
build:
runs-on: 'ubuntu-latest'
steps:
- uses: actions/checkout@v3
with:
submodules: true
- name: Use Python 3.12
uses: actions/setup-python@v5
with:
python-version: 3.12
cache: 'pip'
cache-dependency-path: |
python/requirements.txt
c/requirements.txt
docs/requirements.txt
- uses: ammaraskar/sphinx-action@master
with:
docs-folder: "docs/"
build-command: "make html"
- uses: actions/upload-pages-artifact
with:
path: docs/_build/html/
deploy:
needs: build
runs-on: ubuntu-latest
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4