Skip to content

Commit 06b39e1

Browse files
committed
Implement a barebones CI for setup for the user docs.
Add a "build-test" Makefile target which executes a sphinx docs build with warnings turned into errors. Use this new target within a GitHub workflow such that the ability to build the docs is verified on each commit.
1 parent e2301ef commit 06b39e1

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

.github/workflows/ci.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: User Docs
2+
3+
on:
4+
5+
jobs:
6+
test-build:
7+
runs-on: ubuntu-latest
8+
steps:
9+
- uses: actions/checkout@v4
10+
- name: Set up latest stable Python 3.x
11+
uses: actions/setup-python@v5
12+
with:
13+
python-version: "3.x"
14+
- name: Install dependencies
15+
run: |
16+
make dependencies
17+
- name: Ensure the docs build
18+
run: |
19+
make test-build

Makefile

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ dependencies: ./.venv/pyvenv.cfg ./requirements.txt
2020
./requirements.txt:
2121
@
2222

23+
.PHONY: test-build
24+
test-build: dependencies
25+
@$(SPHINXBUILD) -W "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
26+
2327
# Catch-all target: route all unknown targets to Sphinx using the new
2428
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
2529
.PHONY: Makefile

0 commit comments

Comments
 (0)