Index of Names

A

A - B - C - D - E - F - G - H - I - L - M - N - O - P - R - S - T - U - V - W - _

ANY - napoleon.docstring.TokenType.ANY
astext - napoleon.docstring.Token.astext
attr1 - numpy_demo.ExampleClass.attr1
attr2 - numpy_demo.ExampleClass.attr2
attr3 - numpy_demo.ExampleClass.attr3
attr4 - numpy_demo.ExampleClass.attr4
attr5 - numpy_demo.ExampleClass.attr5

B

A - B - C - D - E - F - G - H - I - L - M - N - O - P - R - S - T - U - V - W - _

build - napoleon.docstring.Tokenizer.build

C

A - B - C - D - E - F - G - H - I - L - M - N - O - P - R - S - T - U - V - W - _

code - numpy_demo.ExampleError.code
content - napoleon.docstring.Field.content
CONTROL - napoleon.docstring.TokenType.CONTROL
counter - napoleon.iterators.peek_iter.counter

D

A - B - C - D - E - F - G - H - I - L - M - N - O - P - R - S - T - U - V - W - _

DELIMITER - napoleon.docstring.TokenType.DELIMITER
docstring - napoleon.docstring

E

A - B - C - D - E - F - G - H - I - L - M - N - O - P - R - S - T - U - V - W - _

example_generator - numpy_demo.example_generator
example_method - numpy_demo.ExampleClass.example_method
ExampleClass - numpy_demo.ExampleClass
ExampleError - numpy_demo.ExampleError

F

A - B - C - D - E - F - G - H - I - L - M - N - O - P - R - S - T - U - V - W - _

Field - napoleon.docstring.Field
FreeFormException - napoleon.docstring.FreeFormException
function_with_pep484_type_annotations - numpy_demo.function_with_pep484_type_annotations
function_with_types_in_docstring - numpy_demo.function_with_types_in_docstring

G

A - B - C - D - E - F - G - H - I - L - M - N - O - P - R - S - T - U - V - W - _

GoogleDocstring - napoleon.docstring.GoogleDocstring

H

A - B - C - D - E - F - G - H - I - L - M - N - O - P - R - S - T - U - V - W - _

has_next - napoleon.iterators.peek_iter.has_next

I

A - B - C - D - E - F - G - H - I - L - M - N - O - P - R - S - T - U - V - W - _

is_google_typed_arg - napoleon.docstring.is_google_typed_arg
is_obj_identifier - napoleon.docstring.is_obj_identifier
is_type - napoleon.docstring.is_type
iterators - napoleon.iterators
ITokenizer - napoleon.docstring.ITokenizer

L

A - B - C - D - E - F - G - H - I - L - M - N - O - P - R - S - T - U - V - W - _

lineno - napoleon.docstring.Field.lineno
lines
- napoleon.docstring.FreeFormException.lines
- napoleon.docstring.GoogleDocstring.lines
LITERAL - napoleon.docstring.TokenType.LITERAL

M

A - B - C - D - E - F - G - H - I - L - M - N - O - P - R - S - T - U - V - W - _

modifier - napoleon.iterators.modify_iter.modifier
modify_iter - napoleon.iterators.modify_iter
module_level_function - numpy_demo.module_level_function
module_level_variable1 - numpy_demo.module_level_variable1
module_level_variable2 - numpy_demo.module_level_variable2
msg - numpy_demo.ExampleError.msg

N

A - B - C - D - E - F - G - H - I - L - M - N - O - P - R - S - T - U - V - W - _

name - napoleon.docstring.Field.name
napoleon - napoleon
next - napoleon.iterators.peek_iter.next
numpy_demo - numpy_demo
NumpyDocstring - napoleon.docstring.NumpyDocstring

O

A - B - C - D - E - F - G - H - I - L - M - N - O - P - R - S - T - U - V - W - _

OBJ - napoleon.docstring.TokenType.OBJ

P

A - B - C - D - E - F - G - H - I - L - M - N - O - P - R - S - T - U - V - W - _

peek - napoleon.iterators.peek_iter.peek
peek_iter - napoleon.iterators.peek_iter

R

A - B - C - D - E - F - G - H - I - L - M - N - O - P - R - S - T - U - V - W - _

readonly_property - numpy_demo.ExampleClass.readonly_property
readwrite_property - numpy_demo.ExampleClass.readwrite_property
readwrite_property.setter - numpy_demo.ExampleClass.readwrite_property.setter
recombine_sets - napoleon.docstring.Tokenizer.recombine_sets
REFERENCE - napoleon.docstring.TokenType.REFERENCE

S

A - B - C - D - E - F - G - H - I - L - M - N - O - P - R - S - T - U - V - W - _

sentinel - napoleon.iterators.peek_iter.sentinel

T

A - B - C - D - E - F - G - H - I - L - M - N - O - P - R - S - T - U - V - W - _

T - napoleon.iterators.T
Token - napoleon.docstring.Token
tokenize_str - napoleon.docstring.Tokenizer.tokenize_str
Tokenizer - napoleon.docstring.Tokenizer
tokens
- napoleon.docstring.ITokenizer.tokens
- napoleon.docstring.Tokenizer.tokens
TokenType - napoleon.docstring.TokenType
type
- napoleon.docstring.Field.type
- napoleon.docstring.Token.type
TypeDocstring - napoleon.docstring.TypeDocstring

U

A - B - C - D - E - F - G - H - I - L - M - N - O - P - R - S - T - U - V - W - _

UNKNOWN - napoleon.docstring.TokenType.UNKNOWN

V

A - B - C - D - E - F - G - H - I - L - M - N - O - P - R - S - T - U - V - W - _

value - napoleon.docstring.Token.value

W

A - B - C - D - E - F - G - H - I - L - M - N - O - P - R - S - T - U - V - W - _

warnings

_

A - B - C - D - E - F - G - H - I - L - M - N - O - P - R - S - T - U - V - W - _

__bool__ - napoleon.docstring.Field.__bool__
__init__
- napoleon.docstring.GoogleDocstring.__init__
- napoleon.docstring.ITokenizer.__init__
- napoleon.docstring.Tokenizer.__init__
- napoleon.docstring.TypeDocstring.__init__
- napoleon.iterators.modify_iter.__init__
- napoleon.iterators.peek_iter.__init__
- numpy_demo.ExampleClass.__init__
- numpy_demo.ExampleError.__init__
__iter__ - napoleon.iterators.peek_iter.__iter__
__next__ - napoleon.iterators.peek_iter.__next__
__special__ - numpy_demo.ExampleClass.__special__
__special_without_docstring__ - numpy_demo.ExampleClass.__special_without_docstring__
__str__
- napoleon.docstring.GoogleDocstring.__str__
- napoleon.docstring.TypeDocstring.__str__
_additional_warnings - napoleon.docstring.Tokenizer._additional_warnings
_ast_like_delimiters_regex - napoleon.docstring.TypeDocstring._ast_like_delimiters_regex
_ast_like_delimiters_regex_str - napoleon.docstring.TypeDocstring._ast_like_delimiters_regex_str
_bullet_list_regex - napoleon.docstring._bullet_list_regex
_cache - napoleon.iterators.peek_iter._cache
_consume_contiguous - napoleon.docstring.GoogleDocstring._consume_contiguous
_consume_empty - napoleon.docstring.GoogleDocstring._consume_empty
_consume_field
- napoleon.docstring.GoogleDocstring._consume_field
- napoleon.docstring.NumpyDocstring._consume_field
_consume_fields
- napoleon.docstring.GoogleDocstring._consume_fields
- napoleon.docstring.NumpyDocstring._consume_fields
_consume_indented_block - napoleon.docstring.GoogleDocstring._consume_indented_block
_consume_inline_attribute - napoleon.docstring.GoogleDocstring._consume_inline_attribute
_consume_returns_section
- napoleon.docstring.GoogleDocstring._consume_returns_section
- napoleon.docstring.NumpyDocstring._consume_returns_section
_consume_section_header
- napoleon.docstring.GoogleDocstring._consume_section_header
- napoleon.docstring.NumpyDocstring._consume_section_header
_consume_to_end - napoleon.docstring.GoogleDocstring._consume_to_end
_consume_to_next_section - napoleon.docstring.GoogleDocstring._consume_to_next_section
_convert_type - napoleon.docstring.GoogleDocstring._convert_type
_convert_type_and_maybe_consume_free_form_field - napoleon.docstring.NumpyDocstring._convert_type_and_maybe_consume_free_form_field
_convert_type_spec_to_rst - napoleon.docstring.TypeDocstring._convert_type_spec_to_rst
_dedent - napoleon.docstring.GoogleDocstring._dedent
_default_regex - napoleon.docstring.TypeDocstring._default_regex
_directive_regex - napoleon.docstring._directive_regex
_enumerated_list_regex - napoleon.docstring._enumerated_list_regex
_escape_args_and_kwargs
- napoleon.docstring.GoogleDocstring._escape_args_and_kwargs
- napoleon.docstring.NumpyDocstring._escape_args_and_kwargs
_fillcache
- napoleon.iterators.modify_iter._fillcache
- napoleon.iterators.peek_iter._fillcache
_fix_field_desc - napoleon.docstring.GoogleDocstring._fix_field_desc
_format_admonition - napoleon.docstring.GoogleDocstring._format_admonition
_format_block - napoleon.docstring.GoogleDocstring._format_block
_format_docutils_params - napoleon.docstring.GoogleDocstring._format_docutils_params
_format_field - napoleon.docstring.GoogleDocstring._format_field
_format_fields - napoleon.docstring.GoogleDocstring._format_fields
_get_current_indent - napoleon.docstring.GoogleDocstring._get_current_indent
_get_indent - napoleon.docstring.GoogleDocstring._get_indent
_get_initial_indent - napoleon.docstring.GoogleDocstring._get_initial_indent
_get_min_indent - napoleon.docstring.GoogleDocstring._get_min_indent
_google_section_regex - napoleon.docstring._google_section_regex
_google_typed_arg_regex - napoleon.docstring._google_typed_arg_regex
_indent - napoleon.docstring.GoogleDocstring._indent
_is_in_section - napoleon.docstring.GoogleDocstring._is_in_section
_is_indented - napoleon.docstring.GoogleDocstring._is_indented
_is_list - napoleon.docstring.GoogleDocstring._is_list
_is_section_break
- napoleon.docstring.GoogleDocstring._is_section_break
- napoleon.docstring.NumpyDocstring._is_section_break
_is_section_header
- napoleon.docstring.GoogleDocstring._is_section_header
- napoleon.docstring.NumpyDocstring._is_section_header
_iterable - napoleon.iterators.peek_iter._iterable
_line_iter - napoleon.docstring.GoogleDocstring._line_iter
_name_rgx - napoleon.docstring.GoogleDocstring._name_rgx
_natural_language_delimiters_regex - napoleon.docstring.TypeDocstring._natural_language_delimiters_regex
_natural_language_delimiters_regex_str - napoleon.docstring.TypeDocstring._natural_language_delimiters_regex_str
_numpy_section_regex - napoleon.docstring._numpy_section_regex
_parse - napoleon.docstring.GoogleDocstring._parse
_parse_admonition - napoleon.docstring.GoogleDocstring._parse_admonition
_parse_attribute_docstring - napoleon.docstring.GoogleDocstring._parse_attribute_docstring
_parse_attributes_section - napoleon.docstring.GoogleDocstring._parse_attributes_section
_parse_examples_section - napoleon.docstring.GoogleDocstring._parse_examples_section
_parse_generic_section - napoleon.docstring.GoogleDocstring._parse_generic_section
_parse_keyword_arguments_section - napoleon.docstring.GoogleDocstring._parse_keyword_arguments_section
_parse_methods_section - napoleon.docstring.GoogleDocstring._parse_methods_section
_parse_notes_section - napoleon.docstring.GoogleDocstring._parse_notes_section
_parse_numpydoc_see_also_section - napoleon.docstring.NumpyDocstring._parse_numpydoc_see_also_section
_parse_parameters_section - napoleon.docstring.GoogleDocstring._parse_parameters_section
_parse_raises_section - napoleon.docstring.GoogleDocstring._parse_raises_section
_parse_references_section - napoleon.docstring.GoogleDocstring._parse_references_section
_parse_returns_section - napoleon.docstring.GoogleDocstring._parse_returns_section
_parse_see_also_section
- napoleon.docstring.GoogleDocstring._parse_see_also_section
- napoleon.docstring.NumpyDocstring._parse_see_also_section
_parse_warns_section - napoleon.docstring.GoogleDocstring._parse_warns_section
_parsed_lines - napoleon.docstring.GoogleDocstring._parsed_lines
_partition_field_on_colon - napoleon.docstring.GoogleDocstring._partition_field_on_colon
_partition_multiline_field_on_colon - napoleon.docstring.GoogleDocstring._partition_multiline_field_on_colon
_private - numpy_demo.ExampleClass._private
_private_without_docstring - numpy_demo.ExampleClass._private_without_docstring
_process_type_fields - napoleon.docstring.GoogleDocstring._process_type_fields
_section_indent - napoleon.docstring.GoogleDocstring._section_indent
_sections - napoleon.docstring.GoogleDocstring._sections
_single_colon_regex - napoleon.docstring._single_colon_regex
_strip_empty - napoleon.docstring.GoogleDocstring._strip_empty
_T - napoleon.docstring._T
_token_regex - napoleon.docstring.TypeDocstring._token_regex
_token_type - napoleon.docstring.Tokenizer._token_type
_tokens - napoleon.docstring.TypeDocstring._tokens
_what - napoleon.docstring.GoogleDocstring._what
_xref_or_code_regex - napoleon.docstring._xref_or_code_regex
_xref_regex - napoleon.docstring._xref_regex