Skip to content

Commit 5747e4a

Browse files
committed
MNT: Sync doc-requirements with pyproject.toml
1 parent 68a10e4 commit 5747e4a

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

doc-requirements.txt

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
# Requirements for building docs
1+
# Auto-generated by tools/update_requirements.py
22
-r requirements.txt
3-
sphinx<3
3+
matplotlib >= 1.5.3
44
numpydoc
5+
sphinx ~= 5.3
56
texext
6-
matplotlib >=1.3.1
7+
tomli; python_version < "3.11"

tools/update_requirements.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,12 @@
1111
pyproject_toml = repo_root / "pyproject.toml"
1212
reqs = repo_root / "requirements.txt"
1313
min_reqs = repo_root / "min-requirements.txt"
14+
doc_reqs = repo_root / "doc-requirements.txt"
1415

1516
with open(pyproject_toml, 'rb') as fobj:
1617
config = tomli.load(fobj)
1718
requirements = config["project"]["dependencies"]
19+
doc_requirements = config["project"]["optional-dependencies"]["doc"]
1820

1921
script_name = Path(__file__).relative_to(repo_root)
2022

@@ -27,3 +29,7 @@
2729
# Write minimum requirements
2830
lines[1:-1] = [req.replace(">=", "==").replace("~=", "==") for req in requirements]
2931
min_reqs.write_text("\n".join(lines))
32+
33+
# Write documentation requirements
34+
lines[1:-1] = ["-r requirements.txt"] + doc_requirements
35+
doc_reqs.write_text("\n".join(lines))

0 commit comments

Comments
 (0)