Skip to content

Commit d729445

Browse files
committed
Add GH Pages workflow
1 parent f87256e commit d729445

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

.github/workflows/documentation.yml

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: documentation
2+
3+
on: [push, pull_request, workflow_dispatch]
4+
5+
permissions:
6+
contents: write
7+
8+
jobs:
9+
docs:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v4
13+
- uses: actions/setup-python@v5
14+
- name: Install dependencies
15+
run: |
16+
python3.8 -m venv .venv
17+
.venv/bin/python -m pip install --upgrade pip
18+
.venv/bin/pip install -e ".[dev]"
19+
- uses: siacodelabs/setup-pandoc@v1
20+
- name: Sphinx build
21+
run: |
22+
.venv/bin/sphinx-build -b html docs docs/_build
23+
- name: Deploy to GitHub Pages
24+
uses: peaceiris/actions-gh-pages@v3
25+
with:
26+
publish_branch: gh-pages
27+
github_token: ${{ secrets.GITHUB_TOKEN }}
28+
publish_dir: docs/_build/
29+
force_orphan: true

0 commit comments

Comments
 (0)