numpydoc
numpydoc copied to clipboard
numpy
Numpy's Sphinx extensions
I recently found myself trying to document a mix of normal attributes and *properties* on a class using Numpydoc for the first time, and it *did not work well.* I...
Hello, I found a similar issue to #214 which has already been fixed. I believe the trigger is when the reference appears before the first section of the document. The...
Parameter lists allow a specification like: ``` my_param : type specification Description ``` In some cases we at scikit-learn have had long type specifications that overflow into the next line...
Simply using the autosummary extension from sphinx burys classmethods amongst all of the other methods in a class. To make them easier for users to find, I could separately reference...
The documentation https://numpydoc.readthedocs.io/en/latest/format.html#id10 Says that the ``Returns`` section is not applicable in class docstrings. What to do if the class implements ``__call__``? E.g. vectorize uses the section https://docs.scipy.org/doc/numpy/reference/generated/numpy.vectorize.html Thanks
foobar.py: ```python def main(): """ Some fooings, refer to :ref:`the-title` and :doc:`/index`. See Also -------- :ref:`the-title` :doc:`/index` """ ``` index.rst ```rst .. _the-title: Welcome to foo's documentation! =============================== .. toctree::...
The [RT02 error](https://github.com/numpy/numpydoc/blob/master/numpydoc/validate.py#L78) has the description: > "The first line of the Returns section should contain only the type, unless multiple values are being returned" This appears to enforce the...
Could the GL01 check in numpydoc be dsiabled by default, please? It contradicts the examples at the [numpydoc docstring guide](https://numpydoc.readthedocs.io/en/latest/format.html#sections), and also [PEP-257](https://www.python.org/dev/peps/pep-0257/#what-is-a-docstring) where it says "The summary line may...
The recently added `numpydoc.validate` functionality fails on the reference docstring in `doc/example.py`. ```py >>> from numpydoc.validate import validate >>> validate("doc.example.foo") {'type': 'function', [...] 'deprecated': False, 'file': '/home/rth/src/numpydoc/doc/example.py', 'file_line': 37, 'errors':...
I am trying to reduce the number of warnings produced in a numpy doc build. As reported in numpy/numpy#12827, I see many warnings of the form "/home/circleci/repo/venv/lib/python3.6/site-packages/numpy/core/_internal.py:docstring of numpy.core._internal._ctypes.shape:1: **WARNING:...
