Skip to content

Commit 469575e

Browse files
📝 [docs] Add documentation workflow
1 parent 0de0b7c commit 469575e

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

.github/workflows/docs.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Build and Deploy Docs
2+
on:
3+
push:
4+
branches:
5+
- main # or master, depending on your default branch name
6+
7+
jobs:
8+
build-and-deploy:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v2
12+
13+
- name: Set up Python
14+
uses: actions/setup-python@v2
15+
with:
16+
python-version: '3.x'
17+
18+
- name: Install dependencies
19+
run: |
20+
python -m pip install --upgrade pip
21+
pip install sphinx sphinx-rtd-theme # add any other dependencies your docs need
22+
23+
- name: Build docs
24+
run: |
25+
cd docs
26+
make html
27+
28+
- name: Deploy to GitHub Pages
29+
uses: peaceiris/actions-gh-pages@v3
30+
with:
31+
github_token: ${{ secrets.GITHUB_TOKEN }}
32+
publish_dir: ./docs/_build/html

0 commit comments

Comments
 (0)