Skip to content

Commit b743666

Browse files
committed
chore: generate documentation
1 parent 54b6516 commit b743666

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

.github/workflows/docs.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Generate documentation
2+
3+
on:
4+
push:
5+
pull_request:
6+
workflow_dispatch:
7+
8+
jobs:
9+
docs:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v3
13+
- uses: actions/setup-python@v4
14+
- name: Install dependencies
15+
run: pip install sphinx sphinx_rtd_theme
16+
- name: Sphinx build
17+
run: |
18+
sphinx-build docs _build
19+
- name: Deploy
20+
uses: peaceiris/actions-gh-pages@v3
21+
if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
22+
with:
23+
publish_branch: docs
24+
github_token: ${{ secrets.GITHUB_TOKEN }}
25+
publish_dir: _build/
26+
force_orphan: true

0 commit comments

Comments
 (0)