Skip to content

Update documentation #40

Update documentation

Update documentation #40

Workflow file for this run

name: "Sphinx: Render Documentation"
on:
workflow_dispatch:
push:
branches:
- docs
pull_request:
branches:
- docs
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@v3
with:
name: html-docs
path: docs/build/html/
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: ${{github.ref == 'refs/heads/docs'}}
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/html