Docs for polygon interface #37
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: build_docs | |
on: | |
push: | |
branches: [master] | |
pull_request: | |
branches: ['*'] | |
jobs: | |
build-docs: | |
runs-on: ubuntu-22.04 | |
steps: | |
- uses: actions/[email protected] | |
with: | |
submodules: recursive | |
- uses: actions/[email protected] | |
with: | |
python-version: 3.11 | |
- name: Install dependencies | |
run: | | |
pip install --upgrade pip setuptools wheel | |
pip install -r requirements.in | |
pip install -r requirements-dev.txt | |
pip install .[all] | |
- name: Build the book | |
run: jupyter-book build docs/ --warningiserror --keep-going --all | |
- name: Upload artifacts | |
uses: actions/[email protected] | |
with: | |
name: html | |
path: docs/_build/html | |
- name: Upload to GitHub Pages | |
uses: peaceiris/actions-gh-pages@v4 | |
if: github.ref == 'refs/heads/master' | |
with: | |
github_token: ${{ secrets.GITHUB_TOKEN }} | |
publish_dir: docs/_build/html |