Skip to content

Development

Development #19

Workflow file for this run

name: Deploy Sphinx Docs
on:
push:
branches: [ master ]
pull_request:
branches: [ master ]
types:
- closed
jobs:
build-deploy-docs:
runs-on: ubuntu-latest
if: github.event_name == 'pull_request' && github.event.pull_request.merged == true
steps:
- name: Check out the repository
uses: actions/checkout@v2
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: '3.12'
- name: Install dependencies
run: |
pip install hatch
- name: Build Sphinx documentation
run: |
hatch run docs:build
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/html
publish_branch: gh-pages