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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
:py:mod:`autodoc2.analysis`
===========================
.. py:module:: autodoc2.analysis
.. autodoc2-docstring:: autodoc2.analysis
:allowtitles:
Module Contents
---------------
Classes
~~~~~~~
.. list-table::
:class: autosummary longtable
:align: left
* - :py:obj:`State <autodoc2.analysis.State>`
- .. autodoc2-docstring:: autodoc2.analysis.State
:summary:
Functions
~~~~~~~~~
.. list-table::
:class: autosummary longtable
:align: left
* - :py:obj:`analyse_module <autodoc2.analysis.analyse_module>`
- .. autodoc2-docstring:: autodoc2.analysis.analyse_module
:summary:
* - :py:obj:`_get_full_name <autodoc2.analysis._get_full_name>`
- .. autodoc2-docstring:: autodoc2.analysis._get_full_name
:summary:
* - :py:obj:`_get_parent_name <autodoc2.analysis._get_parent_name>`
- .. autodoc2-docstring:: autodoc2.analysis._get_parent_name
:summary:
* - :py:obj:`fix_docstring_indent <autodoc2.analysis.fix_docstring_indent>`
- .. autodoc2-docstring:: autodoc2.analysis.fix_docstring_indent
:summary:
* - :py:obj:`walk_node <autodoc2.analysis.walk_node>`
- .. autodoc2-docstring:: autodoc2.analysis.walk_node
:summary:
* - :py:obj:`yield_module <autodoc2.analysis.yield_module>`
- .. autodoc2-docstring:: autodoc2.analysis.yield_module
:summary:
* - :py:obj:`yield_annotation_assign <autodoc2.analysis.yield_annotation_assign>`
- .. autodoc2-docstring:: autodoc2.analysis.yield_annotation_assign
:summary:
* - :py:obj:`yield_assign <autodoc2.analysis.yield_assign>`
- .. autodoc2-docstring:: autodoc2.analysis.yield_assign
:summary:
* - :py:obj:`_yield_assign <autodoc2.analysis._yield_assign>`
- .. autodoc2-docstring:: autodoc2.analysis._yield_assign
:summary:
* - :py:obj:`yield_function_def <autodoc2.analysis.yield_function_def>`
- .. autodoc2-docstring:: autodoc2.analysis.yield_function_def
:summary:
* - :py:obj:`yield_class_def <autodoc2.analysis.yield_class_def>`
- .. autodoc2-docstring:: autodoc2.analysis.yield_class_def
:summary:
Data
~~~~
.. list-table::
:class: autosummary longtable
:align: left
* - :py:obj:`__all__ <autodoc2.analysis.__all__>`
- .. autodoc2-docstring:: autodoc2.analysis.__all__
:summary:
* - :py:obj:`_dc_kwargs <autodoc2.analysis._dc_kwargs>`
- .. autodoc2-docstring:: autodoc2.analysis._dc_kwargs
:summary:
* - :py:obj:`_FUNC_MAPPER <autodoc2.analysis._FUNC_MAPPER>`
- .. autodoc2-docstring:: autodoc2.analysis._FUNC_MAPPER
:summary:
API
~~~
.. py:data:: __all__
:canonical: autodoc2.analysis.__all__
:value: ['analyse_module']
.. autodoc2-docstring:: autodoc2.analysis.__all__
.. py:function:: analyse_module(file_path: pathlib.Path, name: str, exclude_external_imports: typing.Pattern[str] | None = None) -> typing.Iterable[autodoc2.utils.ItemData]
:canonical: autodoc2.analysis.analyse_module
.. autodoc2-docstring:: autodoc2.analysis.analyse_module
.. py:data:: _dc_kwargs
:canonical: autodoc2.analysis._dc_kwargs
:type: dict[str, bool]
:value: None
.. autodoc2-docstring:: autodoc2.analysis._dc_kwargs
.. py:class:: State
:canonical: autodoc2.analysis.State
.. autodoc2-docstring:: autodoc2.analysis.State
.. py:attribute:: package_name
:canonical: autodoc2.analysis.State.package_name
:type: str
:value: None
.. autodoc2-docstring:: autodoc2.analysis.State.package_name
.. py:attribute:: name_stack
:canonical: autodoc2.analysis.State.name_stack
:type: list[str]
:value: None
.. autodoc2-docstring:: autodoc2.analysis.State.name_stack
.. py:attribute:: exclude_external_imports
:canonical: autodoc2.analysis.State.exclude_external_imports
:type: typing.Pattern[str] | None
:value: None
.. autodoc2-docstring:: autodoc2.analysis.State.exclude_external_imports
.. py:method:: copy(**kwargs: typing.Any) -> autodoc2.analysis.State
:canonical: autodoc2.analysis.State.copy
.. autodoc2-docstring:: autodoc2.analysis.State.copy
.. py:function:: _get_full_name(name: str, name_stack: list[str]) -> str
:canonical: autodoc2.analysis._get_full_name
.. autodoc2-docstring:: autodoc2.analysis._get_full_name
.. py:function:: _get_parent_name(name: str) -> str
:canonical: autodoc2.analysis._get_parent_name
.. autodoc2-docstring:: autodoc2.analysis._get_parent_name
.. py:function:: fix_docstring_indent(s: None | str, tabsize: int = 8) -> str
:canonical: autodoc2.analysis.fix_docstring_indent
.. autodoc2-docstring:: autodoc2.analysis.fix_docstring_indent
.. py:function:: walk_node(node: astroid.nodes.NodeNG, state: autodoc2.analysis.State) -> typing.Iterable[autodoc2.utils.ItemData]
:canonical: autodoc2.analysis.walk_node
.. autodoc2-docstring:: autodoc2.analysis.walk_node
.. py:function:: yield_module(node: astroid.nodes.Module, state: autodoc2.analysis.State) -> typing.Iterable[autodoc2.utils.ItemData]
:canonical: autodoc2.analysis.yield_module
.. autodoc2-docstring:: autodoc2.analysis.yield_module
.. py:function:: yield_annotation_assign(node: astroid.nodes.AnnAssign, state: autodoc2.analysis.State) -> typing.Iterable[autodoc2.utils.ItemData]
:canonical: autodoc2.analysis.yield_annotation_assign
.. autodoc2-docstring:: autodoc2.analysis.yield_annotation_assign
.. py:function:: yield_assign(node: astroid.nodes.Assign, state: autodoc2.analysis.State) -> typing.Iterable[autodoc2.utils.ItemData]
:canonical: autodoc2.analysis.yield_assign
.. autodoc2-docstring:: autodoc2.analysis.yield_assign
.. py:function:: _yield_assign(node: astroid.nodes.Assign | astroid.nodes.AnnAssign, state: autodoc2.analysis.State) -> typing.Iterable[autodoc2.utils.ItemData]
:canonical: autodoc2.analysis._yield_assign
.. autodoc2-docstring:: autodoc2.analysis._yield_assign
.. py:function:: yield_function_def(node: astroid.nodes.FunctionDef | astroid.nodes.AsyncFunctionDef, state: autodoc2.analysis.State) -> typing.Iterable[autodoc2.utils.ItemData]
:canonical: autodoc2.analysis.yield_function_def
.. autodoc2-docstring:: autodoc2.analysis.yield_function_def
.. py:function:: yield_class_def(node: astroid.nodes.ClassDef, state: autodoc2.analysis.State) -> typing.Iterable[autodoc2.utils.ItemData]
:canonical: autodoc2.analysis.yield_class_def
.. autodoc2-docstring:: autodoc2.analysis.yield_class_def
.. py:data:: _FUNC_MAPPER
:canonical: autodoc2.analysis._FUNC_MAPPER
:type: dict[astroid.nodes.NodeNG, typing.Callable[[astroid.nodes.NodeNG, autodoc2.analysis.State], typing.Iterable[autodoc2.utils.ItemData]]]
:value: None
.. autodoc2-docstring:: autodoc2.analysis._FUNC_MAPPER
|
