-
Notifications
You must be signed in to change notification settings - Fork 1.5k
separate docs and dev requirements #5883
Copy link
Copy link
Closed
Labels
Description
the requirements-dev.txt is out-of-date in terms of documentation requirement docs/requirements.txt, these should be unified to avoid conflicting packages
Lines 30 to 33 in 2d0e021
| Sphinx==3.5.3 | |
| recommonmark==0.6.0 | |
| sphinx-autodoc-typehints==1.11.1 | |
| sphinx-rtd-theme==0.5.2 |
Lines 12 to 16 in 2d0e021
| Sphinx | |
| pydata-sphinx-theme | |
| sphinxcontrib-applehelp | |
| sphinxcontrib-devhelp | |
| sphinxcontrib-htmlhelp |
(docs/requirements.txt is required/used by read-the-docs, while requirements-dev.txt is for setting up dev environment for unit/integration tests.)
it causes incompatible deps issues such as:
>>> import skimage
Traceback (most recent call last):
File "<stdin>", line 1, in <module>
File "/usr/local/anaconda3/envs/py38/lib/python3.8/site-packages/skimage/__init__.py", line 157, in <module>
from .util.dtype import (img_as_float32,
File "/usr/local/anaconda3/envs/py38/lib/python3.8/site-packages/skimage/util/__init__.py", line 9, in <module>
from .apply_parallel import apply_parallel
File "/usr/local/anaconda3/envs/py38/lib/python3.8/site-packages/skimage/util/apply_parallel.py", line 60, in <module>
def apply_parallel(function, array, chunks=None, depth=0, mode=None,
File "/usr/local/anaconda3/envs/py38/lib/python3.8/site-packages/skimage/_shared/utils.py", line 351, in __call__
newdoc = docstring_add_deprecated(
File "/usr/local/anaconda3/envs/py38/lib/python3.8/site-packages/skimage/_shared/utils.py", line 185, in docstring_add_deprecated
from numpydoc.docscrape import FunctionDoc, Parameter
File "/usr/local/anaconda3/envs/py38/lib/python3.8/site-packages/numpydoc/__init__.py", line 30, in <module>
_verify_sphinx_jinja()
File "/usr/local/anaconda3/envs/py38/lib/python3.8/site-packages/numpydoc/__init__.py", line 23, in _verify_sphinx_jinja
raise VersionRequirementError(
sphinx.errors.VersionRequirementError:
Sphinx<4.0.2 is incompatible with Jinja2>=3.1.
If you wish to continue using sphinx<4.0.2 you need to pin Jinja2<3.1.
Reactions are currently unavailable