Skip to content

Sphinx documentation update #56

Sphinx documentation update

Sphinx documentation update #56

Workflow file for this run

name: Deploy Sphinx documentation to Pages
on:
push:
branches: [main] # branch to trigger deployment
jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v4
- name: Build HTML
uses: ammaraskar/sphinx-action@master
- name: Upload artifacts
uses: actions/upload-artifact@v4
with:
name: html-docs
path: docs/docs/html
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: github.ref == 'refs/heads/main'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/docs/html