-
Notifications
You must be signed in to change notification settings - Fork 0
37 lines (30 loc) · 845 Bytes
/
docs.yml
File metadata and controls
37 lines (30 loc) · 845 Bytes
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
name: Build Docs and Render
on:
push:
branches: [ main ]
workflow_dispatch:
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: '3.11'
- name: Install package and docs dependencies
run: |
python -m pip install --upgrade pip
pip install -e ".[dev]"
pip install sphinx sphinx-rtd-theme
- name: Build Sphinx HTML
working-directory: docs
run: |
sphinx-build -b html source build/html
- name: Deploy to GitHub Pages (docs branch)
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/build/html
publish_branch: docs