Skip to content

Commit 0eb57fe

Browse files
authored
Using Python 3.14 instead of 3.9 to generate the read the docs documentation (#607)
Fix the correct requirements in docs/requirements.txt Add the httpx2.* classes to the ignore list for docs
1 parent 430bafb commit 0eb57fe

3 files changed

Lines changed: 8 additions & 6 deletions

File tree

‎.readthedocs.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ version: 2
99
build:
1010
os: ubuntu-24.04
1111
tools:
12-
python: "3.9"
12+
python: "3.14"
1313

1414
# Build documentation in the docs/ directory with Sphinx
1515
sphinx:

‎docs/conf.py‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,10 +115,13 @@
115115
('py:class', 'websockets.datastructures.SupportsKeysAndGetItem'),
116116
('py:class', 'websockets.typing.Subprotocol'),
117117

118-
# httpx: no sphinx docs yet https://github.com/encode/httpx/discussions/3091
118+
# httpx/httpx2: no sphinx docs yet https://github.com/encode/httpx/discussions/3091
119119
('py:class', 'httpx.AsyncClient'),
120120
('py:class', 'httpx.Client'),
121121
('py:class', 'httpx.Headers'),
122+
('py:class', 'httpx2.AsyncClient'),
123+
('py:class', 'httpx2.Client'),
124+
('py:class', 'httpx2.Headers'),
122125

123126
# botocore: no sphinx docs
124127
('py:class', 'botocore.auth.BaseSigner'),

‎docs/requirements.txt‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
sphinx>=5.3.0,<6
2-
sphinx_rtd_theme>=0.4,<1
3-
sphinx-argparse==0.2.5
4-
multidict<5.0,>=4.5
1+
sphinx>=8.1.0,<9
2+
sphinx_rtd_theme>=3.0.2,<4
3+
sphinx-argparse==0.5.2

0 commit comments

Comments
 (0)