Skip to content

Commit b5eb6af

Browse files
committed
add sphinx workflow
1 parent 5d537f9 commit b5eb6af

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

.github/workflows/sphinx.yml

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

0 commit comments

Comments
 (0)