-
-
Notifications
You must be signed in to change notification settings - Fork 11.1k
Closed
Description
We recently added the ability for refguide-check to test the *.rst
files in doc
and below. There are failures that should be fixed. Some hints to run the tests and find the broken docstrings:
- the docstrings much match the numpy version, so you should install it locally
- run the refguide-check
python tools/refguide-check.py --rst
Currently for me this prints out many failures, the summary is below
- doc/source/reference/maskedarray.baseclass.rst
- doc/source/reference/arrays.ndarray.rst
- doc/source/reference/routines.polynomials.classes.rst
- doc/source/reference/arrays.datetime.rst (DOC: update datetime reference to pass refguide #15717)
- doc/source/reference/arrays.nditer.rst
- doc/source/reference/arrays.dtypes.rst
- doc/source/reference/arrays.indexing.rst
- doc/source/reference/distutils.rst
- doc/source/reference/arrays.classes.rst
- doc/source/reference/c-api/coremath.rst
- doc/source/f2py/getting-started.rst
- doc/source/user/c-info.python-as-glue.rst
- doc/source/user/quickstart.rst (DOC: Fix quickstart doc to pass refguide #15703)
- doc/source/user/tutorial-svd.rst (DOC: fix SVD tutorial to pass refguide #15710)
ERROR: failed checking doc/source/reference/maskedarray.baseclass.rst
failed checking doc/source/reference/arrays.ndarray.rst
failed checking doc/source/reference/routines.polynomials.classes.rst
failed checking doc/source/reference/arrays.datetime.rst
failed checking doc/source/reference/arrays.nditer.rst
failed checking doc/source/reference/arrays.dtypes.rst
failed checking doc/source/reference/arrays.indexing.rst
failed checking doc/source/reference/distutils.rst
failed checking doc/source/reference/arrays.classes.rst
failed checking doc/source/reference/c-api/coremath.rst
failed checking doc/source/f2py/getting-started.rst
failed checking doc/source/user/c-info.python-as-glue.rst
failed checking doc/source/user/quickstart.rst
When all the errors are fixed, we should enable this check on CI to make sure new errors do not crop up.