Skip to content

Add documentation workflow and Sphinx configuration #3

Add documentation workflow and Sphinx configuration

Add documentation workflow and Sphinx configuration #3

Workflow file for this run

name: documentation
on:
push:
branches: [main]
pull_request:
branches: [main]
workflow_dispatch:
permissions:
contents: write
jobs:
docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v4
with:
python-version: '3.10'
- name: Install dependencies
run: |
python -m pip install -r requirements-docs.txt
python -m pip install .
- name: Sphinx build
run: |
sphinx-build docs docs/_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