Skip to content

Commit 5062400

Browse files
authored
Expand CI to also build sphinx docs (#34)
Adding a step to the ci tester to try to build sphinx docs
1 parent 3d731bf commit 5062400

File tree

1 file changed

+34
-1
lines changed

1 file changed

+34
-1
lines changed

.github/workflows/ci.yml

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ jobs:
6666
shell: bash
6767
run: |
6868
echo "Running tests, installing dependencies with poetry..."
69-
poetry install --with test,lint,typing
69+
poetry install --with test,lint,typing,docs
7070
7171
- name: Run tests
7272
run: make test
@@ -82,3 +82,36 @@ jobs:
8282
# grep will exit non-zero if the target message isn't found,
8383
# and `set -e` above will cause the step to fail.
8484
echo "$STATUS" | grep 'nothing to commit, working tree clean'
85+
test_docs:
86+
timeout-minutes: 5
87+
runs-on: ubuntu-latest
88+
defaults:
89+
run:
90+
working-directory: ${{ env.WORKDIR }}
91+
strategy:
92+
matrix:
93+
python-version:
94+
- "3.11"
95+
name: Documentation Build for Python ${{ matrix.python-version }}
96+
steps:
97+
- uses: actions/checkout@v3
98+
99+
- name: Set up Python ${{ matrix.python-version }} + Poetry ${{ env.POETRY_VERSION }}
100+
uses: "./.github/actions/poetry_setup"
101+
with:
102+
python-version: ${{ matrix.python-version }}
103+
poetry-version: ${{ env.POETRY_VERSION }}
104+
working-directory: .
105+
cache-key: benchmarks-all
106+
107+
- name: Install dependencies
108+
shell: bash
109+
run: |
110+
echo "Running tests, installing dependencies with poetry..."
111+
poetry install --with test,lint,typing,docs
112+
113+
- name: Test Sphinx Docs
114+
shell: bash
115+
run: |
116+
echo "Attempting to build docs..."
117+
make build_docs

0 commit comments

Comments
 (0)