Skip to content

Commit c32e8c7

Browse files
committed
Documentation: Refactor Sphinx dependencies into setup.py
1 parent d93e3cd commit c32e8c7

File tree

5 files changed

+16
-10
lines changed

5 files changed

+16
-10
lines changed

.github/workflows/docs.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ jobs:
2020
fail-fast: false
2121
matrix:
2222
os: ["ubuntu-latest"]
23-
python-version: ["3.11"]
23+
python-version: ["3.12"]
2424

2525
steps:
2626
- uses: actions/checkout@v4
@@ -31,7 +31,7 @@ jobs:
3131

3232
- name: Install package and documentation dependencies
3333
run: |
34-
uv pip install --system '.[develop]' --requirement=docs/requirements.txt
34+
uv pip install --system '.[develop,docs]'
3535
3636
- name: Run link checker
3737
run: |

.readthedocs.yml

+4-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,10 @@ build:
1414

1515
python:
1616
install:
17-
- requirements: docs/requirements.txt
17+
- method: pip
18+
path: .
19+
extra_requirements:
20+
- docs
1821

1922
sphinx:
2023
configuration: docs/source/conf.py

DEVELOP.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ git clone https://github.com/kennethreitz/responder
88
cd responder
99
python3 -m venv .venv
1010
source .venv/bin/activate
11-
pip install --editable '.[graphql,develop,release,test]'
11+
pip install --editable '.[graphql,develop,docs,release,test]'
1212
```
1313

1414
Invoke linter and software tests.
@@ -20,3 +20,8 @@ Format code.
2020
```shell
2121
poe format
2222
```
23+
24+
Documentation authoring.
25+
```shell
26+
poe docs-autobuild
27+
```

docs/requirements.txt

-6
This file was deleted.

setup.py

+4
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,10 @@ def run(self):
121121
"ruff; python_version>='3.7'",
122122
"validate-pyproject",
123123
],
124+
"docs": [
125+
"alabaster<1.1",
126+
"sphinx>=5,<9",
127+
],
124128
"graphql": ["graphene"],
125129
"release": ["build", "twine"],
126130
"test": ["pytest", "pytest-cov", "pytest-mock", "flask"],

0 commit comments

Comments
 (0)