summaryrefslogtreecommitdiff
path: root/doc/source/_templates/autosummary/base.rst
blob: 91bfff9ba8709c5491c9ea55ccf1b9fbea783224 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{% if objtype == 'property' %}
:orphan:
{% endif %}

{{ fullname | escape | underline}}

.. currentmodule:: {{ module }}

{% if objtype == 'property' %}
property
{% endif %}

.. auto{{ objtype }}:: {{ fullname | replace("numpy.", "numpy::") }}

{# In the fullname (e.g. `numpy.ma.MaskedArray.methodname`), the module name
is ambiguous. Using a `::` separator (e.g. `numpy::ma.MaskedArray.methodname`)
specifies `numpy` as the module name. #}