numpydoc
numpydoc copied to clipboard
numpy
Numpy's Sphinx extensions
See https://github.com/numpy/numpy/pull/7626 for examples
I learned about the existence of ``argwhere`` only recently, although I'm using ``where`` very often. One possible reason for this is that "See also" in the [where](https://docs.scipy.org/doc/numpy/reference/generated/numpy.where.html#numpy.where) documentation doesn't link...
scipy/scipy#8702 shows an example where a line with multiple function names prior to the colon (`:`) loses all text after the colon. ``` See Also -------- scipy.stats.kstwobign : Provides the...
Many libraries that use numpydoc also use the Sphinx [`linkcode`](http://www.sphinx-doc.org/en/stable/ext/linkcode.html) feature. In order to use it, they all must define a `linkcode_resolve` function that returns the web URL where the...
I have been trying this sphinx extension for the first time today, and I keep hitting this error. I can't find anywhere where this is the case, so I can't...
autodoc comes with the parameter `autodoc_member_order`, which can be set to one of {'alphabetical', 'groubwise', 'bysource'}: http://www.sphinx-doc.org/en/stable/ext/autodoc.html#confval-autodoc_member_order numpydoc doesn't respect that parameter, but always orders class attributes and methods alphabetically,...
From #134: Some tracing tells me that wrap_mangling_directives results in NumpyPythonDomain's directives being used to handle py:class, py:function, etc. I find it hard to believe that that's the intention. Do...
In IPython, the _Returns_ and _Raises_ sections of our docstrings are often a single block of text, not a definition list. In particular, where functions return a single value, it...
### Setup Mac OS X, Python 3.6, Sphinx 1.6.5, numpydoc 0.7.0 ``` $ python3 -msphinx --version Sphinx (sphinx-build) 1.6.5 $ python3 -c "import numpydoc; print(numpydoc.__version__)" 0.7.0 ``` ### Reproducible example...
It is very easy to mistakenly separate parameter names from their type description by `': '` instead of the correct `' : '`. There are at least 260 instances in...