Skip to content

Commit 0cedd98

Browse files
authored
Add docs requirements to pyproject.toml (#1494)
* Add `docs` requirements to `pyproject.toml` * Add release note * Exclude `numpy` version `1.21.0` Move the RTD exclusion to the `numpy` dependency directly. * Require `numcodecs[msgpack]` for `docs` * Update references for installing doc dependencies
1 parent 6ed4d78 commit 0cedd98

File tree

6 files changed

+18
-19
lines changed

6 files changed

+18
-19
lines changed

Diff for: .pyup.yml

-3
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,3 @@ requirements:
1313
- requirements_dev_optional.txt:
1414
pin: True
1515
update: all
16-
- requirements_rtfd.txt:
17-
pin: False
18-
update: False

Diff for: .readthedocs.yaml

+2-1
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ sphinx:
1010

1111
python:
1212
install:
13-
- requirements: requirements_rtfd.txt
1413
- method: pip
1514
path: .
15+
extra_requirements:
16+
- docs

Diff for: docs/contributing.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -92,8 +92,8 @@ the repository, you can do something like the following::
9292
$ mkdir -p ~/pyenv/zarr-dev
9393
$ python -m venv ~/pyenv/zarr-dev
9494
$ source ~/pyenv/zarr-dev/bin/activate
95-
$ pip install -r requirements_dev_minimal.txt -r requirements_dev_numpy.txt -r requirements_rtfd.txt
96-
$ pip install -e .
95+
$ pip install -r requirements_dev_minimal.txt -r requirements_dev_numpy.txt
96+
$ pip install -e .[docs]
9797

9898
To verify that your development environment is working, you can run the unit tests::
9999

Diff for: docs/release.rst

+3
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@ Maintenance
2424
* Require ``setuptools_scm`` version ``1.5.4``\+
2525
By :user:`John A. Kirkham <jakirkham>` :issue:`1477`.
2626

27+
* Add ``docs`` requirements to ``pyproject.toml``
28+
By :user:`John A. Kirkham <jakirkham>` :issue:`1494`.
29+
2730
.. _release_2.16.0:
2831

2932
2.16.0

Diff for: pyproject.toml

+11-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ maintainers = [
1313
requires-python = ">=3.8"
1414
dependencies = [
1515
'asciitree',
16-
'numpy>=1.20',
16+
'numpy>=1.20,!=1.21.0',
1717
'fasteners',
1818
'numcodecs>=0.10.0',
1919
]
@@ -43,6 +43,16 @@ jupyter = [
4343
'ipytree>=0.2.2',
4444
'ipywidgets>=8.0.0',
4545
]
46+
docs = [
47+
'sphinx',
48+
'sphinx_design',
49+
'sphinx-issues',
50+
'sphinx-copybutton',
51+
'sphinx-rtd-theme',
52+
'pydata-sphinx-theme',
53+
'numpydoc',
54+
'numcodecs[msgpack]',
55+
]
4656

4757
[project.urls]
4858
"Bug Tracker" = "https://github.com/zarr-developers/zarr-python/issues"

Diff for: requirements_rtfd.txt

-12
This file was deleted.

0 commit comments

Comments
 (0)