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
|
:py:mod:`autodoc2.sphinx.autodoc`
=================================
.. py:module:: autodoc2.sphinx.autodoc
.. autodoc2-docstring:: autodoc2.sphinx.autodoc
:allowtitles:
Module Contents
---------------
Classes
~~~~~~~
.. list-table::
:class: autosummary longtable
:align: left
* - :py:obj:`AutodocObject <autodoc2.sphinx.autodoc.AutodocObject>`
- .. autodoc2-docstring:: autodoc2.sphinx.autodoc.AutodocObject
:summary:
Functions
~~~~~~~~~
.. list-table::
:class: autosummary longtable
:align: left
* - :py:obj:`_set_parents <autodoc2.sphinx.autodoc._set_parents>`
- .. autodoc2-docstring:: autodoc2.sphinx.autodoc._set_parents
:summary:
API
~~~
.. py:class:: AutodocObject(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)
:canonical: autodoc2.sphinx.autodoc.AutodocObject
Bases: :py:obj:`sphinx.util.docutils.SphinxDirective`
.. autodoc2-docstring:: autodoc2.sphinx.autodoc.AutodocObject
.. rubric:: Initialization
.. autodoc2-docstring:: autodoc2.sphinx.autodoc.AutodocObject.__init__
.. py:attribute:: required_arguments
:canonical: autodoc2.sphinx.autodoc.AutodocObject.required_arguments
:value: 1
.. autodoc2-docstring:: autodoc2.sphinx.autodoc.AutodocObject.required_arguments
.. py:attribute:: final_argument_whitespace
:canonical: autodoc2.sphinx.autodoc.AutodocObject.final_argument_whitespace
:value: False
.. autodoc2-docstring:: autodoc2.sphinx.autodoc.AutodocObject.final_argument_whitespace
.. py:attribute:: has_content
:canonical: autodoc2.sphinx.autodoc.AutodocObject.has_content
:value: True
.. autodoc2-docstring:: autodoc2.sphinx.autodoc.AutodocObject.has_content
.. py:attribute:: option_spec
:canonical: autodoc2.sphinx.autodoc.AutodocObject.option_spec
:type: typing.ClassVar[dict[str, typing.Any]]
:value: None
.. autodoc2-docstring:: autodoc2.sphinx.autodoc.AutodocObject.option_spec
.. py:method:: run() -> list[docutils.nodes.Node]
:canonical: autodoc2.sphinx.autodoc.AutodocObject.run
.. autodoc2-docstring:: autodoc2.sphinx.autodoc.AutodocObject.run
.. py:function:: _set_parents(env: sphinx.environment.BuildEnvironment, mod: autodoc2.utils.ItemData, klass: autodoc2.utils.ItemData | None) -> typing.Generator[None, None, None]
:canonical: autodoc2.sphinx.autodoc._set_parents
.. autodoc2-docstring:: autodoc2.sphinx.autodoc._set_parents
|
