Skip to content

Commit af78e98

Browse files
committed
DOC: tweak template to use automodule (not currentmodule)
This ensure that the module gets created a link target added. The trick is tell `automodule` to not document members. This is slightly better than using the `module` directive as it at least pulls the docstring.
1 parent 4a5f927 commit af78e98

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

doc/_templates/autofunctions.rst

+3-2
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,16 @@
22
{{ fullname | escape | underline }}
33

44

5-
.. currentmodule:: {{ fullname }}
5+
.. automodule:: {{ fullname }}
6+
:no-members:
67

78
{% block functions %}
89
{% if functions %}
910

1011
Functions
1112
---------
1213

13-
.. autosummary::
14+
.. autosummary::
1415
:template: autosummary.rst
1516
:toctree:
1617
{% for item in functions %}{% if item not in ['plotting', 'colormaps'] %}

0 commit comments

Comments
 (0)