numpydoc
numpydoc copied to clipboard
numpy
Numpy's Sphinx extensions
I can't work out how to satisfy GL09 when including a deprecation notice. ## Demonstration For example: ### file "sample_code.py" ``` def my_func_wrong(): """Compute my function. What it does in...
Closes https://github.com/numpy/numpydoc/issues/573 There may be a more elegant way to fix this. Problem is that section that starts with deprecation warning comes back indented, and therefore fails to meet the...
Running `uv run doctest.py` on ```py # /// script # dependencies = [ # "numpydoc==1.8.0", # ] # /// from dataclasses import dataclass from numpydoc.validate import validate, get_doc_object @dataclass class...
Added an option for a `exclude_files` option in pyproject.toml config that allows `re` regular expression path exclusions. Unfortunately, most yaml tags use `exclude` to refer to files, which perhaps doesn't...
Hi all. Is it possible to skip specific rules for specific functions? I know that it's possible to use `exclude` to skip all numpydoc validation for matching functions, and that...
Modifies `validate.py` to include checks for constructors methods (`class.__init__`) implemented by class docstring when using the AST validator, which is essential for hook use (probably the majority use case for...
Why: Numpydoc ought to support annotations matching the typing functionality of numpy.typing and the built-in scalar types. What: I am using NumPy 2.3.0, and numpydoc 1.8.0. I was writing some...
numpydoc 1.9.0rc0.dev0 git tip (2025-05-16) CPython 3.12 A round-trip through FunctionDoc improperly removes empty lines after elements of `Parameters`. This in turn breaks doctest. ```python In [1]: def f(): ...:...
At the moment numpydoc will ignore "Attributes" section for dataclasses (or maybe I don't quite understand how to document dataclasses properly): ```python @dataclass class Klass: """ Klass description. Attributes ----------...
Resolves #196 Hi! I ran into the issue that numpydoc does not support typehints before Christmas, so I decided to have a crack at it. I have tried multiple different...
