Skip to content

Commit f6295ce

Browse files
committed
Add workflow file for docs.
1 parent 16e1dd0 commit f6295ce

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed

.github/workflows/docs.yml

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: "Sphinx: Render docs"
2+
3+
on:
4+
push:
5+
branches: ["master"]
6+
7+
jobs:
8+
build:
9+
runs-on: ubuntu-latest
10+
permissions:
11+
contents: write
12+
steps:
13+
- uses: actions/checkout@v4
14+
with:
15+
persist-credentials: false
16+
- name: Build HTML
17+
uses: ammaraskar/sphinx-action@master
18+
- name: Upload artifacts
19+
uses: actions/upload-artifact@v4
20+
with:
21+
name: html-docs
22+
path: docs/build/html/
23+
- name: Deploy
24+
uses: peaceiris/actions-gh-pages@v3
25+
if: github.ref == 'refs/heads/main'
26+
with:
27+
github_token: ${{ secrets.GITHUB_TOKEN }}
28+
publish_dir: docs/build/html

docs/requirements.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
furo==2021.11.16

0 commit comments

Comments
 (0)