numpydoc
numpydoc copied to clipboard
numpy
Numpy's Sphinx extensions
I was looking for a way to skip GL08 checks on class constructors (`__init__`) throughout my code. This is particularly as the numpydoc recommendation for class strings documents the constructor:...
Using the specified `Warnings` section I can get something that looks like this: It would be nice to be able to split this into two separate admonitions. It feels natural...
SciPy has a one-to-one copy of https://github.com/numpy/numpydoc/blob/main/numpydoc/docscrape.py at https://github.com/scipy/scipy/blob/main/scipy/_lib/_docscrape.py. From the file, we use: - `ClassDoc` - `NumpyDocString` - `FunctionDoc` - `Parameter` The use is exclusive to a deprecation utility...
The `See Also` section should be explicitly allowed to contain references to any object. The current situation is murky: - The documentation exclusively mentions functions, without explicitly ruling out other...
## Problem Statement Currently, numpydoc requires configuration to be present in either `pyproject.toml` or `setup.cfg` files within each Python package. This creates challenges in monorepo setups where multiple Python packages...
trivial little PR, I was batch cleaning the repos I have locally.
I'm currently dealing with the case that I want to document a class variable with numpydoc while hacking on [docstub](https://github.com/scientific-python/docstub). How would I do that? Concretely ```python class Foo: """Short...
In scipy/scipy#22609, we're working on documenting support for array arguments beyond NumPy `ndarray`s. We're thinking of including something like this in the documentation of each class/function/method:  Initially, we would...
#571 changed the section order to move Attributes and Methods right behind Parameters. The order is now https://github.com/numpy/numpydoc/blob/532cd7d71ceee4e00fd13fa5faf038f2b4d95905/numpydoc/docscrape.py#L118-L137 For classes, we can get the order `Paramters > Attributes > Methods...
