2023-03-16 22:16:55 +00:00
|
|
|
name: Sphinx docs
|
2022-12-14 16:04:39 +00:00
|
|
|
|
|
|
|
on:
|
|
|
|
push:
|
|
|
|
branches: [ "release" ]
|
|
|
|
paths:
|
|
|
|
- '.github/workflows/sphinx.yml'
|
|
|
|
- 'src/**'
|
|
|
|
- 'docs/**'
|
|
|
|
- 'files/**'
|
|
|
|
|
|
|
|
jobs:
|
|
|
|
docs:
|
|
|
|
runs-on: ubuntu-latest
|
|
|
|
|
|
|
|
steps:
|
2023-10-30 04:51:34 +00:00
|
|
|
- uses: actions/checkout@v4
|
2024-12-16 23:19:46 +00:00
|
|
|
- name: Set up Python 3.12
|
2023-10-30 04:51:34 +00:00
|
|
|
uses: actions/setup-python@v4
|
|
|
|
with:
|
2024-12-16 23:19:46 +00:00
|
|
|
python-version: 3.12.3
|
2022-12-14 16:04:39 +00:00
|
|
|
|
2023-03-16 22:16:55 +00:00
|
|
|
- name: Build docs requirements
|
2024-10-05 21:37:05 +00:00
|
|
|
run: pip install -U -r docs/requirements.txt
|
2023-03-16 22:16:55 +00:00
|
|
|
|
2022-12-14 16:04:39 +00:00
|
|
|
- name: Build docs
|
2022-12-14 16:38:41 +00:00
|
|
|
run: make doc
|
2022-12-14 16:04:39 +00:00
|
|
|
|
|
|
|
- name: Deploy
|
|
|
|
uses: peaceiris/actions-gh-pages@v3
|
|
|
|
with:
|
|
|
|
publish_branch: gh-pages
|
|
|
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
|
|
|
publish_dir: docs/_build/html/
|
|
|
|
force_orphan: true
|