Commit 74df5a8
committed
Add a "doc" extra for documentation build dependencies
And use it in:
- GitHub Actions CI checks
- Read the Docs configuration
- tox (for the "html" environment)
(The tox "html" environment was not previously overriding "extras"
to empty it out of dependencies needed only for linting or testing,
so this happens to make `tox -e html` faster.)1 parent 26dccd7 commit 74df5a8
4 files changed
Lines changed: 9 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -100,5 +100,5 @@ jobs: | |||
| 100 | 100 | ||
| 101 | 101 | - name: Documentation | |
| 102 | 102 | run: | | |
| 103 | - pip install -r doc/requirements.txt | ||
| 103 | + pip install ".[doc]" | ||
| 104 | 104 | make -C doc html | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -32,4 +32,5 @@ python: | |||
| 32 | 32 | install: | |
| 33 | 33 | - method: pip | |
| 34 | 34 | path: . | |
| 35 | - - requirements: doc/requirements.txt | ||
| 35 | + extra_requirements: | ||
| 36 | + - doc | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -17,6 +17,7 @@ def _read_content(path: str) -> str: | |||
| 17 | 17 | version = _read_content("VERSION").strip() | |
| 18 | 18 | requirements = _read_content("requirements.txt").splitlines() | |
| 19 | 19 | test_requirements = _read_content("test-requirements.txt").splitlines() | |
| 20 | + doc_requirements = _read_content("doc/requirements.txt").splitlines() | ||
| 20 | 21 | long_description = _read_content("README.md") | |
| 21 | 22 | ||
| 22 | 23 | ||
@@ -75,7 +76,10 @@ def _stamp_version(filename: str) -> None: | |||
| 75 | 76 | package_dir={"git": "git"}, | |
| 76 | 77 | python_requires=">=3.7", | |
| 77 | 78 | install_requires=requirements, | |
| 78 | - extras_require={"test": test_requirements}, | ||
| 79 | + extras_require={ | ||
| 80 | + "test": test_requirements, | ||
| 81 | + "doc": doc_requirements, | ||
| 82 | + }, | ||
| 79 | 83 | zip_safe=False, | |
| 80 | 84 | long_description=long_description, | |
| 81 | 85 | long_description_content_type="text/markdown", | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -23,7 +23,7 @@ ignore_outcome = true | |||
| 23 | 23 | [testenv:html] | |
| 24 | 24 | description = Build HTML documentation | |
| 25 | 25 | base_python = py{39,310,311,312,38,37} | |
| 26 | - deps = -r doc/requirements.txt | ||
| 26 | + extras = doc | ||
| 27 | 27 | allowlist_externals = make | |
| 28 | 28 | commands = | |
| 29 | 29 | make BUILDDIR={env_tmp_dir}/doc/build -C doc clean | |
0 commit comments