Skip to content

update docs

update docs #23

Workflow file for this run

name: "Sphinx: Render docs"
on: push
jobs:
build:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v4
with:
persist-credentials: false
- name: Set up Python 3.11
uses: actions/setup-python@v5
with:
python-version: '3.11'
cache: pip # Implicitly uses requirements.txt for cache key
- name: Install dependencies
run: |
pip install -r docs/requirements.txt
sudo apt-get update && sudo apt-get install -y pandoc
- name: Add Pandoc to PATH
run: echo "/usr/local/bin" >> $GITHUB_PATH
- name: Build HTML
run: sphinx-build -b html docs docs/build/html
- name: Upload artifacts
uses: actions/upload-artifact@v4
with:
name: html-docs
path: docs/build/html/
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/html