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
|
===================================
:mod:`enum_tools.documentation`
===================================
.. module:: enum_tools.documentation
.. autosummary-widths:: 35/100
Core Functionality
--------------------
.. automodule:: enum_tools.documentation
:noindex:
:no-members:
:autosummary-members: DocumentedEnum,document_enum,document_member
.. autoenum:: enum_tools.documentation.DocumentedEnum
.. autodecorator:: enum_tools.documentation.document_enum
.. autofunction:: enum_tools.documentation.document_member
.. latex:clearpage::
Utilities
--------------------
.. automodulesumm:: enum_tools.documentation
:autosummary-exclude-members: DocumentedEnum,document_enum,document_member
.. autofunction:: enum_tools.documentation.get_base_indent
.. autofunction:: enum_tools.documentation.get_dedented_line
.. autofunction:: enum_tools.documentation.get_tokens
.. autofunction:: enum_tools.documentation.parse_tokens
Warnings
--------------------
.. autoexception:: enum_tools.documentation.MultipleDocstringsWarning
|
