Skip to content

Commit dc5081d

Browse files
authored
Pin the documentation dependencies' versions (#243)
This should make the documentation process more reliable and reproducible across environments.
1 parent 9821040 commit dc5081d

File tree

4 files changed

+34
-4
lines changed

4 files changed

+34
-4
lines changed

.readthedocs.yaml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,4 @@ python:
1717
install:
1818
- method: pip
1919
path: .
20-
# TODO: pin the development dependency versions
21-
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
22-
# - requirements: docs/requirements.txt
20+
- requirements: requirements-docs.txt

MANIFEST.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
include *.py
22
include *.toml
3-
include requirements-dev.in
3+
include requirements-*.in
44
include *.txt
55
include CHANGES
66
include COPYING

requirements-docs.in

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# The documentation-specific development dependencies.
2+
#
3+
# We generate requirements-dev.txt from this file by running
4+
#
5+
# pip install -r requirements-docs.in && pip freeze > requirements-docs.txt
6+
#
7+
# and then modifying the file manually to restrict black and mypy to CPython
8+
sphinx

requirements-docs.txt

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
alabaster==0.7.13
2+
Babel==2.14.0
3+
certifi==2023.11.17
4+
charset-normalizer==3.3.2
5+
docutils==0.20.1
6+
idna==3.6
7+
imagesize==1.4.1
8+
importlib-metadata==7.0.0
9+
Jinja2==3.1.2
10+
MarkupSafe==2.1.3
11+
packaging==23.2
12+
pygments==2.17.2
13+
pytz==2023.3.post1
14+
requests==2.31.0
15+
snowballstemmer==2.2.0
16+
sphinx==7.1.2
17+
sphinxcontrib-applehelp==1.0.4
18+
sphinxcontrib-devhelp==1.0.2
19+
sphinxcontrib-htmlhelp==2.0.1
20+
sphinxcontrib-jsmath==1.0.1
21+
sphinxcontrib-qthelp==1.0.3
22+
sphinxcontrib-serializinghtml==1.1.5
23+
urllib3==2.1.0
24+
zipp==3.17.0

0 commit comments

Comments
 (0)