File: class.rst

package info (click to toggle)
petsc4py 3.23.1-1exp2
  • links: PTS, VCS
  • area: main
  • in suites: experimental
  • size: 3,448 kB
  • sloc: python: 12,503; ansic: 1,697; makefile: 343; f90: 313; sh: 14
file content (85 lines) | stat: -rw-r--r-- 2,159 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
{{ fullname | escape | underline}}

{%- if autotype is defined %}
{%- set objtype = autotype.get(name) or objtype %}
{%- endif %}

.. auto{{ objtype }}:: {{ module}}.{{ objname }}
   :show-inheritance:

   {%- for item in ['__new__', '__init__'] %}
     {%- if item in members and item not in inherited_members %}
     {%- endif %}
   {%- endfor %}

   {%- for item in ['__new__', '__init__'] %}
     {%- if item in methods %}
       {%- set dummy = methods.remove(item) %}
     {%- endif %}
   {%- endfor %}

   {%- for item in inherited_members %}
     {%- if item in methods %}
       {%- set dummy = methods.remove(item) %}
     {%- endif %}
     {%- if item in attributes %}
       {%- set dummy = attributes.remove(item) %}
     {%- endif %}
   {%- endfor %}

   {%- set enumerations = [] %}
   {%- for item in members %}
     {%- if item not in inherited_members and item not in all_methods and item not in all_attributes %}
       {%- set dummy = enumerations.append(item) %}
     {%- endif %}
   {%- endfor %}

   {% block enumerations_documentation %}
   {%- if enumerations %}
   .. rubric:: Enumerations
   .. autosummary::
      :toctree:
   {%+ for item in enumerations %}
      ~{{ fullname }}.{{ item }}
   {%- endfor %}
   {%- endif %}
   {%- endblock %}

   {% block methods_summary %}
   {%- if methods %}
   .. rubric:: Methods Summary
   .. autosummary::
   {%+ for item in methods %}
      ~{{ fullname }}.{{ item }}
   {%- endfor %}
   {%- endif %}
   {%- endblock %}

   {% block attributes_summary %}
   {%- if attributes %}
   .. rubric:: Attributes Summary
   .. autosummary::
   {%+ for item in attributes %}
      ~{{ fullname }}.{{ item }}
   {%- endfor %}
   {%- endif %}
   {%- endblock %}

   {% block methods_documentation %}
   {%- if methods %}
   .. rubric:: Methods Documentation
   {%+ for item in methods %}
   .. automethod:: {{ item }}
   {%- endfor %}
   {%- endif %}
   {%- endblock %}

   {% block attributes_documentation %}
   {%- if attributes %}
   .. rubric:: Attributes Documentation
   {%+ for item in attributes %}
   .. autoattribute:: {{ item }}
   {%- endfor %}
   {%- endif %}
   {%- endblock %}
{# #}