Skip to content

Commit

Permalink
Add docs requirements to pyproject.toml (#1494)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
jakirkham authored Aug 11, 2023
1 parent 6ed4d78 commit 0cedd98
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 19 deletions.
3 changes: 0 additions & 3 deletions .pyup.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,3 @@ requirements:
- requirements_dev_optional.txt:
pin: True
update: all
- requirements_rtfd.txt:
pin: False
update: False
3 changes: 2 additions & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ sphinx:

python:
install:
- requirements: requirements_rtfd.txt
- method: pip
path: .
extra_requirements:
- docs
4 changes: 2 additions & 2 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,8 @@ the repository, you can do something like the following::
$ mkdir -p ~/pyenv/zarr-dev
$ python -m venv ~/pyenv/zarr-dev
$ source ~/pyenv/zarr-dev/bin/activate
$ pip install -r requirements_dev_minimal.txt -r requirements_dev_numpy.txt -r requirements_rtfd.txt
$ pip install -e .
$ pip install -r requirements_dev_minimal.txt -r requirements_dev_numpy.txt
$ pip install -e .[docs]

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

Expand Down
3 changes: 3 additions & 0 deletions docs/release.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ Maintenance
* Require ``setuptools_scm`` version ``1.5.4``\+
By :user:`John A. Kirkham <jakirkham>` :issue:`1477`.

* Add ``docs`` requirements to ``pyproject.toml``
By :user:`John A. Kirkham <jakirkham>` :issue:`1494`.

.. _release_2.16.0:

2.16.0
Expand Down
12 changes: 11 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ maintainers = [
requires-python = ">=3.8"
dependencies = [
'asciitree',
'numpy>=1.20',
'numpy>=1.20,!=1.21.0',
'fasteners',
'numcodecs>=0.10.0',
]
Expand Down Expand Up @@ -43,6 +43,16 @@ jupyter = [
'ipytree>=0.2.2',
'ipywidgets>=8.0.0',
]
docs = [
'sphinx',
'sphinx_design',
'sphinx-issues',
'sphinx-copybutton',
'sphinx-rtd-theme',
'pydata-sphinx-theme',
'numpydoc',
'numcodecs[msgpack]',
]

[project.urls]
"Bug Tracker" = "https://github.com/zarr-developers/zarr-python/issues"
Expand Down
12 changes: 0 additions & 12 deletions requirements_rtfd.txt

This file was deleted.

0 comments on commit 0cedd98

Please sign in to comment.