Skip to content

docs

docs #149

Workflow file for this run

name: docs
on:
workflow_dispatch:
push:
tags:
- 'v*.*.*'
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python 3.12
uses: actions/setup-python@v5
with:
python-version: '3.12'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install --upgrade setuptools
pip install -r ./docs/sphinx_requirements.txt
pip install --verbose --editable .
- name: Build documents
run: |
cd ./docs/
make clean
mkdir -p _images
make html
env:
GA_TRACKING_ID: ${{ secrets.GA_TRACKING_ID }}
- name: Deploy
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_branch: gh-pages
publish_dir: ./docs/_build/html/