numpydoc
numpydoc copied to clipboard
numpy
Numpy's Sphinx extensions
Python doesn't natively support function overloading (like how C++ does), but imitates it with optional positional and keyword arguments. With the advent of the `typing.overload` decorator, we have the ability...
The Style guide currently gives the following recommendations about backticks: In the [Parameters](https://numpydoc.readthedocs.io/en/latest/format.html#parameters) section: > Enclose variables in single backticks In [Other points to keep in mind](https://numpydoc.readthedocs.io/en/latest/format.html#other-points-to-keep-in-mind): > For inline...
The recent release of numpydoc 1.6.0 caused our builds to start failing with the exact error from #268. Pegging numpydoc to 1.5.0 allows our builds to continue. Excerpt from pyproject.toml:...
See https://github.com/readthedocs/sphinx-autoapi/issues/421 😄
## Description When I ran the docstring validator on a docstring with a "See Also" section that contains an object reference starting with a tilde, I got a `ValueError` that...
### Issue/bug Currently, the following invalid directive syntax is not checked by `numpydoc-validation` ``` .. directive:: Some text ``` The `numpydoc-validation` checks will pass, but the invalid syntax will result...
Hello, A brief request for feedback and a question: * What could Sphinx do to make things easier for numpydoc? (If nothing: great!) * Are there any parts of numpydoc...
The numpydoc standard states: > Enclose variables in single backticks. The colon must be preceded by a space, or omitted if the type is absent. In sphinx itself, single-backticks are...
When(/if) https://peps.python.org/pep-0727/ is adopted then parameter and return/yield descriptions can be attached directly to the type. Having a "Parameters" section or a "Returns" section in the docs will not be...
I love the ability to include the `numpydoc` validations in my pre-commit routine. Sorry, I got busy and couldn't help with testing. As I've been implementing the validations as a...
