Skip to content

Commit 8d58557

Browse files
whotmartinpitt
authored andcommitted
doc: hook up sphinx
1 parent e7e18d8 commit 8d58557

File tree

5 files changed

+239
-114
lines changed

5 files changed

+239
-114
lines changed

.github/workflows/pages.yml

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
name: Deploy to GitHub pages
2+
3+
on:
4+
push:
5+
branches: ["main"]
6+
7+
# Allow running this workflow manually from the Actions tab
8+
workflow_dispatch:
9+
10+
permissions:
11+
contents: read
12+
pages: write
13+
id-token: write
14+
15+
# Allow only one concurrent deployment
16+
concurrency:
17+
group: "pages"
18+
cancel-in-progress: false
19+
20+
jobs:
21+
deploy:
22+
runs-on: ubuntu-22.04
23+
environment:
24+
name: github-pages
25+
url: ${{ steps.deployment.outputs.page_url }}
26+
27+
steps:
28+
- uses: actions/checkout@v3
29+
30+
- name: Set up Python
31+
uses: actions/setup-python@v4
32+
33+
- name: Install dependencies from pip
34+
run: pip install sphinx sphinx-rtd-theme sphinx-autoapi myst-parser
35+
36+
- name: Build with sphinx
37+
run: sphinx-build -M html doc/ doc/
38+
39+
- name: Move output to target directory
40+
run: mv doc/html public_html/
41+
42+
- name: Setup Pages
43+
uses: actions/configure-pages@v3
44+
45+
- name: Upload pages artifact
46+
uses: actions/upload-pages-artifact@v1
47+
with:
48+
path: public_html/
49+
50+
- name: Deploy to GitHub Pages
51+
id: deployment
52+
uses: actions/deploy-pages@v2

.gitignore

+6-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
/dist
2-
/dbusmock/_version.py
3-
__pycache__
41
*.egg-info
5-
MANIFEST
62
/build
3+
/dbusmock/_version.py
4+
/dist
5+
/doc/doctrees
6+
/doc/html
7+
MANIFEST
8+
__pycache__

0 commit comments

Comments
 (0)