diff options
| author | Ross Barnowski <rossbar@berkeley.edu> | 2020-07-20 17:20:10 -0700 |
|---|---|---|
| committer | Ross Barnowski <rossbar@berkeley.edu> | 2020-07-20 17:20:10 -0700 |
| commit | ccead6aaf82c0fb6289760209ab534202c347844 (patch) | |
| tree | 33675384d35de92ff2e356cd7b8196715a416ca9 | |
| parent | 2fb2c250bdfadc3a92e635e9030f9aea34c9c14e (diff) | |
| download | numpy-ccead6aaf82c0fb6289760209ab534202c347844.tar.gz | |
DOC: Add ufunc docstring to generated docs.
Adds the ufunc class to the documentation so that it is included
in the generated html docs and all links to it work.
Slightly modify ufunc docstring to remove unrecognized heading
name.
| -rw-r--r-- | doc/source/reference/ufuncs.rst | 5 | ||||
| -rw-r--r-- | numpy/core/_add_newdocs.py | 4 |
2 files changed, 6 insertions, 3 deletions
diff --git a/doc/source/reference/ufuncs.rst b/doc/source/reference/ufuncs.rst index a0a5a4a06..c729f8d37 100644 --- a/doc/source/reference/ufuncs.rst +++ b/doc/source/reference/ufuncs.rst @@ -298,6 +298,11 @@ them by defining certain special methods. For details, see :class:`ufunc` ============== +.. autosummary:: + :toctree: generated/ + + numpy.ufunc + .. _ufuncs.kwargs: Optional keyword arguments diff --git a/numpy/core/_add_newdocs.py b/numpy/core/_add_newdocs.py index 2461971eb..c3b4374f4 100644 --- a/numpy/core/_add_newdocs.py +++ b/numpy/core/_add_newdocs.py @@ -4457,10 +4457,8 @@ add_newdoc('numpy.core', 'ufunc', A detailed explanation of ufuncs can be found in the docs for :ref:`ufuncs`. - Calling ufuncs: - =============== + **Calling ufuncs:** ``op(*x[, out], where=True, **kwargs)`` - op(*x[, out], where=True, **kwargs) Apply `op` to the arguments `*x` elementwise, broadcasting the arguments. The broadcasting rules are: |