autodocsumm
stable
Configuration of the sphinx extension
Examples
API Reference
autodocsumm
Index
Edit on GitHub
Index
A
|
C
|
D
|
E
|
F
|
G
|
H
|
L
|
M
|
N
|
O
|
P
|
R
|
S
A
add_autosummary() (AutosummaryDocumenter method)
add_content() (AutoSummClassDocumenter method)
(AutoSummModuleDocumenter method)
autoclasssumm (directive)
autodata_content
configuration value
autodocsumm
module
autodocsumm-grouper
event
autodocsumm_section_sorter
configuration value
AutoDocSummDirective (class in autodocsumm)
automodulesumm (directive)
AutosummaryDocumenter (class in autodocsumm)
AutoSummClassDocumenter (class in autodocsumm)
AutoSummModuleDocumenter (class in autodocsumm)
C
CallableAttributeDocumenter (class in autodocsumm)
CallableDataDocumenter (class in autodocsumm)
configuration value
autodata_content
autodocsumm_section_sorter
document_data
not_document_data
D
do_something() (MyClass method)
document_data
configuration value
dont_document_data() (in module autodocsumm)
dummy
module
E
event
autodocsumm-grouper
F
filter_funcs (AutosummaryDocumenter attribute)
format_args() (CallableAttributeDocumenter method)
(CallableDataDocumenter method)
G
get_doc() (CallableAttributeDocumenter method)
(CallableDataDocumenter method)
get_grouped_documenters() (AutosummaryDocumenter method)
grouper_funcs (AutosummaryDocumenter attribute)
H
has_content (AutoDocSummDirective attribute)
L
large_data (in module dummy)
list_option() (in module autodocsumm)
M
member_options (in module autodocsumm)
member_sections (AutoSummClassDocumenter attribute)
(AutoSummModuleDocumenter attribute)
module
autodocsumm
dummy
MyClass (class in dummy)
N
NoDataAttributeDocumenter (class in autodocsumm)
NoDataDataDocumenter (class in autodocsumm)
not_document_data
configuration value
O
option_spec (AutoDocSummDirective attribute)
(AutoSummClassDocumenter attribute)
(AutoSummModuleDocumenter attribute)
optional_arguments (AutoDocSummDirective attribute)
P
priority (AutoSummClassDocumenter attribute)
(AutoSummModuleDocumenter attribute)
(CallableAttributeDocumenter attribute)
(CallableDataDocumenter attribute)
(NoDataAttributeDocumenter attribute)
(NoDataDataDocumenter attribute)
R
required_arguments (AutoDocSummDirective attribute)
S
setup() (in module autodocsumm)
some_attr (MyClass attribute)
some_other_attr (MyClass attribute)
Read the Docs
v: stable
Versions
latest
stable
Downloads
On Read the Docs
Project Home
Builds