-
Notifications
You must be signed in to change notification settings - Fork 0
36 lines (30 loc) · 1.01 KB
/
static.yaml
File metadata and controls
36 lines (30 loc) · 1.01 KB
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
name: Build and Deploy Sphinx
on:
push:
branches: ["main"] # Change this to "master" if that is your default branch
permissions:
contents: write
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.x'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx sphinx-rtd-theme sphinx-autodoc-typehints furo
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
pip install . # Install the local package to make it importable
- name: Build Sphinx Documentation
run: |
sphinx-build -b html docs/source docs/build/html
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/build/html