Skip to content

Clean up and document; tests #53

Clean up and document; tests

Clean up and document; tests #53

Workflow file for this run

name: documentation
on:
pull_request:
push:
branches:
- main
release:
types:
- published
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 100
persist-credentials: false
- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: "3.11"
- name: Install dependencies
shell: bash -l {0}
run: |
python -m pip install --upgrade pip
python -m pip install -r requirements-dev.txt
- name: Create docs
shell: bash -l {0}
run: make html
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
if: success() && github.event_name == 'release'
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/html/
force_orphan: true