xref: /petsc/src/binding/petsc4py/docs/source/_templates/autosummary/module.rst (revision 5a48edb989d3ea10d6aff6c0e26d581c18691deb) 
1{{ fullname | escape | underline}}
2
3.. automodule:: {{ fullname }}
4   {%- if synopsis is defined %}
5   :synopsis: {{ synopsis.get(fullname, '') }}
6   {%- endif %}
7
8   {% block classes %}
9   {%- if classes %}
10   .. rubric:: {{ _('Classes') }}
11   .. autosummary::
12      :toctree:
13   {% for item in classes %}
14      {{ item }}
15   {%- endfor %}
16   {%- endif %}
17   {%- endblock %}
18
19   {% block exceptions %}
20   {%- if exceptions %}
21   .. rubric:: {{ _('Exceptions') }}
22   .. autosummary::
23      :toctree:
24   {% for item in exceptions %}
25      {{ item }}
26   {%- endfor %}
27   {%- endif %}
28   {%- endblock %}
29
30   {% block functions %}
31   {%- if functions %}
32   .. rubric:: {{ _('Functions') }}
33   .. autosummary::
34      :toctree:
35   {% for item in functions %}
36      {{ item }}
37   {%- endfor %}
38   {%- endif %}
39   {%- endblock %}
40
41   {% block attributes %}
42   {%- if attributes %}
43   .. rubric:: {{ _('Attributes') }}
44   .. autosummary::
45      :toctree:
46   {% for item in attributes %}
47      {{ item }}
48   {%- endfor %}
49   {%- endif %}
50   {%- endblock %}
51
52{% block modules %}
53{%- if modules %}
54.. rubric:: {{ _('Modules') }}
55.. autosummary::
56   :toctree:
57   :recursive:
58{% for item in modules %}
59   {{ item }}
60{%- endfor %}
61{%- endif %}
62{%- endblock %}
63