-
Notifications
You must be signed in to change notification settings - Fork 0
40 lines (33 loc) · 1013 Bytes
/
Copy pathdocs.yml
File metadata and controls
40 lines (33 loc) · 1013 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
38
39
40
name: Build and Deploy Docs
on:
push:
branches: [main]
pull_request:
branches: [main]
workflow_dispatch:
jobs:
docs:
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.12'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install sphinx sphinx-autodoc-typehints myst-parser
pip install -r requirements.txt || true
pip install -r docs/requirements.txt || true
- name: Generate API docs
run: sphinx-apidoc -o docs/api kipu
- name: Build documentation
run: sphinx-build -b html docs docs/_build/html
- 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