Skip to content

Commit e4cdbbe

Browse files
committed
Cleanup dep management and add doc building test
1 parent 2a96895 commit e4cdbbe

File tree

3 files changed

+18
-6
lines changed

3 files changed

+18
-6
lines changed

.github/workflows/python-test.yml

+6-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ jobs:
5050
sccache: 'true'
5151
container: 'off'
5252
working-directory: ./python
53-
args: --extras devel
53+
args: --extras devel,docs
5454

5555
- name: Run lints
5656
run: |
@@ -64,6 +64,11 @@ jobs:
6464
source .venv/bin/activate
6565
pytest
6666
67+
- name: Build docs
68+
run: |
69+
source .venv/bin/activate
70+
sphinx-build -M html docs/source/ docs/build/
71+
6772
build:
6873
runs-on: ubuntu-latest
6974
steps:

.readthedocs.yml

+6-3
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ sphinx:
2323
# Optional but recommended, declare the Python requirements required
2424
# to build your documentation
2525
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
26-
# python:
27-
# install:
28-
# - requirements: docs/requirements.txt
26+
python:
27+
install:
28+
- method: pip
29+
path: python
30+
extra_requirements:
31+
- docs

python/pyproject.toml

+6-2
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,13 @@ devel = [
2323
"mypy~=1.13.0",
2424
"pytest~=8.3",
2525
"pytest-benchmark~=5.1",
26-
"ruff~=0.7.2",
26+
"ruff~=0.7.2"
27+
]
28+
29+
docs = [
2730
"sphinx~=8.1",
28-
"sphinx-rtd-theme=~3.0"
31+
"sphinx-automodapi~=0.18",
32+
"sphinx-rtd-theme~=3.0"
2933
]
3034

3135
[project.urls]

0 commit comments

Comments
 (0)