Skip to content

Build docs

Build docs #4

Workflow file for this run

name: "Build docs"
on:
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
jobs:
build_docs:
# The type of runner that the job will run on
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: "3.12"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r requirements_docs.txt
pip install -r requirements_dev.txt
pip install -e .
- name: Build HTML
run: |
cd docs/
make html
- name: Sphinx build
run: |
sphinx-build doc _build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
with:
publish_branch: gh-pages
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: _build/
force_orphan: true