-
Notifications
You must be signed in to change notification settings - Fork 2
36 lines (32 loc) · 869 Bytes
/
docs.yml
File metadata and controls
36 lines (32 loc) · 869 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
name: Build & Deploy Docs
on:
push:
branches: [main]
permissions:
contents: write
pages: write
id-token: write
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v5
with:
python-version: "3.10"
- name: Install depdencies
run: |
python -m pip install -U pip
pip install .
pip install sphinx sphinx-rtd-theme
- name: Build Docs
run: sphinx-build -b html docs/source docs/_build/html
- name: add .nojekyll
run: touch docs/_build/html/.nojekyll
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: docs/_build/html
publish_branch: gh-pages
force_orphan: true