File: api_module.rst

package info (click to toggle)
taurus 5.2.3-2
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 100,792 kB
  • sloc: python: 51,356; sh: 67; makefile: 12
file content (64 lines) | stat: -rw-r--r-- 948 bytes parent folder | download | duplicates (3)
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
.. currentmodule:: {{modulename}}

:mod:`{{modulename}}`
{{ '=' * (modulename|count + 7 ) }}

.. automodule:: {{modulename}}

{% if submodules|count >0 %}
.. rubric:: Submodules

.. toctree::
    :maxdepth: 1
{% for sm in submodules %}
    {{ sm }}
{% endfor %}
{% endif %}


{% if classes|count >0 %}
.. rubric:: Classes

.. toctree::
    :hidden:
{% for c in classes %}
    {{ c }} <{{modulename}}-{{c}}.rst>
{% endfor %}

{% for c in classes|sort %}
.. autoclass:: {{ c }}
    :noindex:

    (:ref:`more info<{{modulename}}-{{c}}>`)


{% endfor %}

{% endif %}

{% if functions|count >0 %}
.. rubric:: Functions

{% for f in functions|sort %}
.. autofunction:: {{ f }}
{% endfor %}
{% endif %}


{% if exceptions|count >0 %}
.. rubric:: Exceptions

{% for o in other|sort %}
.. autoexception:: {{ o }}
{% endfor %}
{% endif %}


{% if other|count >0 %}
.. rubric:: Variables

{% for o in other|sort %}
.. data:: {{ o }}

{% endfor %}
{% endif %}