Index

A

all (autoapi.mappers.python.objects.TopLevelPythonPythonMapper attribute) annotation (autoapi.mappers.python.objects.PythonData attribute) args (autoapi.mappers.python.objects.PythonClass attribute) (autoapi.mappers.python.objects.PythonPythonMapper attribute) autoapi-inheritance-diagram (directive) autoapi-skip-member event autoapi_add_toctree_entry configuration value autoapi_dirs configuration value autoapi_file_patterns configuration value autoapi_generate_api_docs configuration value autoapi_ignore configuration value autoapi_keep_files configuration value autoapi_member_order configuration value

autoapi_options configuration value autoapi_python_class_content configuration value autoapi_python_use_implicit_namespaces configuration value autoapi_root configuration value autoapi_template_dir configuration value autoapi_type configuration value autoapiattribute (directive) autoapiclass (directive) autoapidata (directive) autoapiexception (directive) autoapifunction (directive) autoapimethod (directive) autoapimodule (directive)

B

bases (autoapi.mappers.python.objects.PythonClass attribute)

C

classes (autoapi.mappers.python.objects.TopLevelPythonPythonMapper attribute) configuration value autoapi_add_toctree_entry autoapi_dirs autoapi_file_patterns autoapi_generate_api_docs autoapi_ignore autoapi_keep_files autoapi_member_order autoapi_options autoapi_python_class_content autoapi_python_use_implicit_namespaces autoapi_root autoapi_template_dir autoapi_type

D

display (autoapi.mappers.python.objects.PythonPythonMapper attribute) docstring (autoapi.mappers.python.objects.PythonClass attribute) (autoapi.mappers.python.objects.PythonPythonMapper attribute)

DotNetPythonMapper (class in autoapi.mappers.dotnet)

E

event autoapi-skip-member

F

functions (autoapi.mappers.python.objects.TopLevelPythonPythonMapper attribute)

G

GoPythonMapper (class in autoapi.mappers.go)

I

inherited (autoapi.mappers.python.objects.PythonPythonMapper attribute) is_private_member (autoapi.mappers.python.objects.PythonPythonMapper attribute)

is_special_member (autoapi.mappers.python.objects.PythonPythonMapper attribute) is_undoc_member (autoapi.mappers.python.objects.PythonPythonMapper attribute)

J

JavaScriptPythonMapper (class in autoapi.mappers.javascript)

M

method_type (autoapi.mappers.python.objects.PythonMethod attribute)

N

Noodle (built-in class)

O

overloads (autoapi.mappers.python.objects.PythonFunction attribute)

P

pathname (autoapi.mappers.dotnet.DotNetPythonMapper attribute) properties (autoapi.mappers.python.objects.PythonFunction attribute) (autoapi.mappers.python.objects.PythonMethod attribute) Python Enhancement Proposals PEP 257 PEP 420 PythonAttribute (class in autoapi.mappers.python.objects)

PythonClass (class in autoapi.mappers.python.objects) PythonData (class in autoapi.mappers.python.objects) PythonException (class in autoapi.mappers.python.objects) PythonFunction (class in autoapi.mappers.python.objects) PythonMethod (class in autoapi.mappers.python.objects) PythonModule (class in autoapi.mappers.python.objects) PythonPackage (class in autoapi.mappers.python.objects) PythonPythonMapper (class in autoapi.mappers.python.objects)

R

ref_name (autoapi.mappers.dotnet.DotNetPythonMapper attribute) ref_short_name (autoapi.mappers.dotnet.DotNetPythonMapper attribute)

resolve_spec_identifier() (autoapi.mappers.dotnet.DotNetPythonMapper method) return_annotation (autoapi.mappers.python.objects.PythonFunction attribute)

S

short_name (autoapi.mappers.dotnet.DotNetPythonMapper attribute) (autoapi.mappers.go.GoPythonMapper attribute)

summary (autoapi.mappers.python.objects.PythonPythonMapper attribute)

T

top_level_object (autoapi.mappers.python.objects.TopLevelPythonPythonMapper attribute)

TopLevelPythonPythonMapper (class in autoapi.mappers.python.objects) transform_doc_comments() (autoapi.mappers.dotnet.DotNetPythonMapper static method)

V

value (autoapi.mappers.python.objects.PythonData attribute)