Skip to content

Feature 0.6 (#33)

Feature 0.6 (#33) #9

Workflow file for this run

name: cd-docs
on:
push:
tags:
- 'v[0-9]+.[0-9]+.[0-9]+*'
workflow_dispatch:
jobs:
docs-deploy:
runs-on: ubuntu-latest
timeout-minutes: 30
steps:
- uses: actions/checkout@v3
- name: Cache Python dependencies
uses: actions/cache@v3
with:
path: ~/.cache/pip
key: pip-3.10-docs-${{ hashFiles('**/pyproject.toml') }}
restore-keys: pip-3.10
- name: Set up Python 3.10
uses: actions/setup-python@v3
with:
python-version: '3.10'
- name: Install python dependencies
run: |
pip install --upgrade pip
pip install -e .[docs]
- name: Build HTML docs
id: linkcheck
run: |
make -C docs html
- name: Deploy docs to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_branch: gh-pages
publish_dir: docs/build/html
force_orphan: true