-
Notifications
You must be signed in to change notification settings - Fork 1
38 lines (35 loc) · 948 Bytes
/
docs-deploy.yml
File metadata and controls
38 lines (35 loc) · 948 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
name: docs-deploy
on:
workflow_dispatch:
push:
branches: [ main ]
permissions:
contents: write
pages: write
id-token: write
jobs:
build-and-deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.11'
- name: Install docs requirements
run: |
python -m pip install --upgrade pip
pip install -r docs/requirements.txt
- name: Generate API docs
run: |
sphinx-apidoc -o docs/source torchflow
- name: Build HTML
run: |
python -m sphinx -b html docs/source 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
keep_files: false