Skip to content

Merge pull request #1 from harrydobbs/development #36

Merge pull request #1 from harrydobbs/development

Merge pull request #1 from harrydobbs/development #36

Workflow file for this run

name: docs
on:
push:
branches:
- main
- development
jobs:
deploy:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
with:
python-version: 3.x
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install .[dev]
pip install sphinx sphinx-autodoc-typehints
- name: Sphinx build
run: |
sphinx-apidoc -o docs/source .
cd docs
make html
- name: Deploy
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/html