Skip to content

Commit b9ad0ee

Browse files
committed
add template
1 parent 1a3249d commit b9ad0ee

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

docs/source/_templates/module.rst

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
{{ fullname }}
2+
{{ underline }}
3+
4+
.. automodule:: {{ fullname }}
5+
6+
{% block functions %}
7+
{% if functions %}
8+
9+
Functions
10+
---------
11+
12+
{% for item in functions %}
13+
14+
.. autofunction:: {{ item }}
15+
16+
.. include:: backreferences/{{fullname}}.{{item}}.examples
17+
18+
.. raw:: html
19+
20+
<div class="sphx-glr-clear"></div>
21+
22+
{%- endfor %}
23+
{% endif %}
24+
{% endblock %}
25+
26+
{% block classes %}
27+
{% if classes %}
28+
29+
Classes
30+
-------
31+
32+
{% for item in classes %}
33+
.. autoclass:: {{ item }}
34+
:members:
35+
36+
.. include:: backreferences/{{fullname}}.{{item}}.examples
37+
38+
.. raw:: html
39+
40+
<div class="sphx-glr-clear"></div>
41+
42+
{%- endfor %}
43+
{% endif %}
44+
{% endblock %}
45+
46+
{% block exceptions %}
47+
{% if exceptions %}
48+
49+
Exceptions
50+
----------
51+
52+
.. autosummary::
53+
{% for item in exceptions %}
54+
{{ item }}
55+
{%- endfor %}
56+
{% endif %}
57+
{% endblock %}

0 commit comments

Comments
 (0)