-
Notifications
You must be signed in to change notification settings - Fork 0
42 lines (35 loc) · 1.06 KB
/
apidocs.yml
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
41
42
name: apidocs
on:
- push
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: Set up Python 3.8
uses: actions/setup-python@v5
with:
python-version: 3.8
- name: Install requirements for documentation generation
run: |
python -m pip install --upgrade pip setuptools wheel
python -m pip install docutils sphinx
- name: Cleanup and setup
run: |
rm -rf ttcal/docs/api
mkdir -p build/docs
mkdir -p public
- name: Generate API documentation with sphinx
run: |
# sphinx-apidoc -o docs/api ttcal ttcal/migrations ttcal/vendor
sphinx-apidoc -o docs/api ttcal
cp docs/api/* docs
rm -rf docs/api
sphinx-build -b html docs build/docs
cp -rf build/docs/* public/
- name: Push API documentation to Github Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./public
commit_message: "Generate API documentation"