Skip to content

Update README and TODO #15

Update README and TODO

Update README and TODO #15

Workflow file for this run

name: Deploy docs
on: push
jobs:
docs:
name: Build and deploy Sphinx docs
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: 3.11
- uses: snok/[email protected]
- name: Install dependencies
run: poetry install
- name: Build docs
run: poetry run sphinx-build -M html docs/ docs/build/
- name: Upload artifacts
uses: actions/upload-artifact@v4
with:
name: html-docs
path: docs/build/html/
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
if: github.ref == 'refs/heads/main'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/html/