numpydoc
numpydoc copied to clipboard
numpy
Numpy's Sphinx extensions
The Raises section generates errors when running `make html &> error.txt`. ``` /home/charris/.local/lib/python2.7/site-packages/numpy/fft/fftpack.py:docstring of numpy.fft.fft2:38: WARNING: Explicit markup ends without a blank line; unexpected unindent. /home/charris/.local/lib/python2.7/site-packages/numpy/fft/fftpack.py:docstring of numpy.fft.fftn:37: WARNING: Explicit...
The `dev`-version breaks the links I have in my `Methods`-section: ``` Methods ------- :py:meth:`~xxx.xxx` Some totally descriptive explanation. ``` I suspect it was #63 that broke this and it worked...
It would be great if each docstring section had its own link anchor (perhaps with corresponding sphinx role, or perhaps just a `ref` for simplicity), and even better if each...
Probably, somewhere you can add warnings filter, which will catch this UserWarning from docscrape.py if `-W` option is enabled.
What is the convention for parameter type if a parameter is an instance of specific class, e.g. datetime.datetime? Specifically, I have a parameter which can be either a float, datetime.date,...
I have a vectorized function. If scalars are passed as inputs, the output is scalar. If some selected (vectorized) inputs have dimension > 0, the output is array. How to...
The way in which numpydoc manages bibliographic references is causing me some problems in conjunction with the latex sphinx builder. 1) Whenever I have an `automodule` directive, all the docstrings...
This PR adds validation check for optional parameters. If an optional parameter exists in the signature of a function, the documentation is checked for one of three options in the...
I've been playing with doc build for a while now, using this [sandbox repository ](https://github.com/mscheltienne/simple-stimuli) with a simple project and code-base. I am running into an issue a bit similar...
This issue was initially opened by @rok here: https://github.com/pydata/pydata-sphinx-theme/issues/388. > When I want to copy a name of a function parameter I typically double-click it to select. Normally that would...
