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