Skip to content

docs

docs #132

Workflow file for this run

name: docs
on:
workflow_run:
workflows: ["tests"]
branches:
- main
types:
- completed
jobs:
pages:
runs-on: ubuntu-latest
steps:
- name: checkout
uses: actions/checkout@v4
- name: pysetup
uses: actions/setup-python@v5
with:
python-version: "3.10"
- name: build
run: |
# sphinx-autodoc needs target package to be installed
##pip install -e ".[doc]"
pip install -e .
# See doc/requirements.txt for why we can't use
# pip install -e ".[doc]"
pip install -r doc/requirements.txt
cd doc
sh generate-doc.sh
- name: deploy
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
# base dir is checkout: /path/to/psweep
publish_dir: doc/source/_build/html