Skip to content

Update website

Update website #8

Workflow file for this run

name: docs
on:
push:
branches:
- main
paths:
- 'docs/**'
permissions:
contents: write
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Install documentation dependencies
run: |
pip install sphinx sphinx-book-theme sphinx-design myst-parser \
sphinx-autodoc-typehints sphinx-copybutton
pip install -e . --no-deps
- name: Build Sphinx documentation
run: |
sphinx-build docs docs_build
touch docs_build/.nojekyll
- name: Deploy to gh-pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs_build
publish_branch: gh-pages