All Documents

• numpy_demo
  numpy_demo.html
  Package
  Package
  PUBLIC
  Pydoctor pre-process Numpy-style docstrings to convert them to reStructuredText. All standard reStructuredText formatting will still works as expected.
• napoleon
  napoleon.html
  Package
  Package
  PUBLIC
  Convert docstrings from numpy or google style format to reST.
• napoleon.docstring
  napoleon.docstring.html
  Module
  Module
  PUBLIC
  Classes for google-style and numpy-style docstring conversion.
• napoleon.iterators
  napoleon.iterators.html
  Module
  Module
  PUBLIC
  A collection of helpful iterators.
• numpy_demo.module_level_variable1
  numpy_demo.html#module_level_variable1
  Attribute
  Variable
  PUBLIC
  Module level variables may be documented in either the Attributes section of the module docstring, or in an inline docstring immediately following the variable.
• numpy_demo.module_level_variable2
  numpy_demo.html#module_level_variable2
  Attribute
  Variable
  PUBLIC
  Module level variable documented inline.
• numpy_demo.function_with_types_in_docstring
  numpy_demo.html#function_with_types_in_docstring
  Function
  Function
  PUBLIC
  Example function with types documented in the docstring.
• numpy_demo.function_with_pep484_type_annotations
  numpy_demo.html#function_with_pep484_type_annotations
  Function
  Function
  PUBLIC
  Example function with PEP 484 type annotations.
• numpy_demo.module_level_function
  numpy_demo.html#module_level_function
  Function
  Function
  PUBLIC
  This is an example of a module level function.
• numpy_demo.example_generator
  numpy_demo.html#example_generator
  Function
  Function
  PUBLIC
  Generators have a Yields section instead of a Returns section.
• numpy_demo.ExampleError
  numpy_demo.ExampleError.html
  Class
  Exception
  PUBLIC
  Exceptions are documented in the same way as classes.
• numpy_demo.ExampleError.msg
  numpy_demo.ExampleError.html#msg
  Attribute
  Instance Variable
  PUBLIC
  Human readable string describing the exception.
• numpy_demo.ExampleError.code
  numpy_demo.ExampleError.html#code
  Attribute
  Instance Variable
  PUBLIC
  Numeric error code.
• numpy_demo.ExampleError.__init__
  numpy_demo.ExampleError.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• numpy_demo.ExampleClass
  numpy_demo.ExampleClass.html
  Class
  Class
  PUBLIC
  The summary line for a class docstring should fit on one line.
• numpy_demo.ExampleClass.attr1
  numpy_demo.ExampleClass.html#attr1
  Attribute
  Instance Variable
  PUBLIC
  Description of attr1.
• numpy_demo.ExampleClass.attr2
  numpy_demo.ExampleClass.html#attr2
  Attribute
  Instance Variable
  PUBLIC
  Description of attr2.
• numpy_demo.ExampleClass.__init__
  numpy_demo.ExampleClass.html#__init__
  Function
  Method
  PUBLIC
  Example of docstring on the __init__ method.
• numpy_demo.ExampleClass.attr3
  numpy_demo.ExampleClass.html#attr3
  Attribute
  Instance Variable
  PUBLIC
  Doc comment inline with attribute
• numpy_demo.ExampleClass.attr4
  numpy_demo.ExampleClass.html#attr4
  Attribute
  Instance Variable
  PUBLIC
  Doc comment before attribute, with type specified
• numpy_demo.ExampleClass.attr5
  numpy_demo.ExampleClass.html#attr5
  Attribute
  Instance Variable
  PUBLIC
  Docstring after attribute, with type specified.
• numpy_demo.ExampleClass.readonly_property
  numpy_demo.ExampleClass.html#readonly_property
  Attribute
  Property
  PUBLIC
  Properties should be documented in their getter method.
• numpy_demo.ExampleClass.readwrite_property
  numpy_demo.ExampleClass.html#readwrite_property
  Attribute
  Property
  PUBLIC
  Properties with both a getter and setter should only be documented in their getter method.
• numpy_demo.ExampleClass.readwrite_property.setter
  numpy_demo.ExampleClass.html#readwrite_property.setter
  Function
  Method
  PUBLIC
  Undocumented
• numpy_demo.ExampleClass.example_method
  numpy_demo.ExampleClass.html#example_method
  Function
  Method
  PUBLIC
  Class methods are similar to regular functions.
• numpy_demo.ExampleClass.__special__
  numpy_demo.ExampleClass.html#__special__
  Function
  Method
  PUBLIC
  Dunder methods are considered public and will be included in the output.
• numpy_demo.ExampleClass.__special_without_docstring__
  numpy_demo.ExampleClass.html#__special_without_docstring__
  Function
  Method
  PUBLIC
  Undocumented
• numpy_demo.ExampleClass._private
  numpy_demo.ExampleClass.html#_private
  Function
  Method
  PRIVATE
  Private members are any methods or attributes that start with an underscore and are not special.
• numpy_demo.ExampleClass._private_without_docstring
  numpy_demo.ExampleClass.html#_private_without_docstring
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.iterators.T
  napoleon.iterators.html#T
  Attribute
  Type Variable
  PUBLIC
  Undocumented
• napoleon.iterators.peek_iter
  napoleon.iterators.peek_iter.html
  Class
  Class
  PUBLIC
  An iterator object that supports peeking ahead.
• napoleon.iterators.peek_iter.sentinel
  napoleon.iterators.peek_iter.html#sentinel
  Attribute
  Instance Variable
  PUBLIC
  The value used to indicate the iterator is exhausted. If sentinel was not given when the peek_iter was instantiated, then it will be set to a new object instance: object().
• napoleon.iterators.peek_iter.counter
  napoleon.iterators.peek_iter.html#counter
  Attribute
  Instance Variable
  PUBLIC
  Store and increment line number to report correct lines!
• napoleon.iterators.peek_iter.__init__
  napoleon.iterators.peek_iter.html#__init__
  Function
  Method
  PUBLIC
  No summary
• napoleon.iterators.peek_iter._iterable
  napoleon.iterators.peek_iter.html#_iterable
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• napoleon.iterators.peek_iter._cache
  napoleon.iterators.peek_iter.html#_cache
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• napoleon.iterators.peek_iter.__iter__
  napoleon.iterators.peek_iter.html#__iter__
  Function
  Method
  PUBLIC
  Undocumented
• napoleon.iterators.peek_iter.__next__
  napoleon.iterators.peek_iter.html#__next__
  Function
  Method
  PUBLIC
  Undocumented
• napoleon.iterators.peek_iter._fillcache
  napoleon.iterators.peek_iter.html#_fillcache
  Function
  Method
  PRIVATE
  Cache n items. If n is 0 or None, then 1 item is cached.
• napoleon.iterators.peek_iter.has_next
  napoleon.iterators.peek_iter.html#has_next
  Function
  Method
  PUBLIC
  Determine if iterator is exhausted.
• napoleon.iterators.peek_iter.next
  napoleon.iterators.peek_iter.html#next
  Function
  Method
  PUBLIC
  Get the next item or n items of the iterator.
• napoleon.iterators.peek_iter.peek
  napoleon.iterators.peek_iter.html#peek
  Function
  Method
  PUBLIC
  Preview the next item or n items of the iterator. The iterator is not advanced when peek is called.
• napoleon.iterators.modify_iter
  napoleon.iterators.modify_iter.html
  Class
  Class
  PUBLIC
  An iterator object that supports modifying items as they are returned.
• napoleon.iterators.modify_iter.modifier
  napoleon.iterators.modify_iter.html#modifier
  Attribute
  Instance Variable
  PUBLIC
  modifier is called with each item in o as it is iterated. The return value of modifier is returned in lieu of the item. Values returned by peek as well as next are affected by modifier. However, sentinel...
• napoleon.iterators.modify_iter.__init__
  napoleon.iterators.modify_iter.html#__init__
  Function
  Method
  PUBLIC
  No summary
• napoleon.iterators.modify_iter._fillcache
  napoleon.iterators.modify_iter.html#_fillcache
  Function
  Method
  PRIVATE
  Cache n modified items. If n is 0 or None, 1 item is cached. Each item returned by the iterator is passed through the modify_iter.modifier function before being cached.
• napoleon.docstring._directive_regex
  napoleon.docstring.html#_directive_regex
  Attribute
  Variable
  PRIVATE
  Undocumented
• napoleon.docstring._google_section_regex
  napoleon.docstring.html#_google_section_regex
  Attribute
  Variable
  PRIVATE
  Undocumented
• napoleon.docstring._google_typed_arg_regex
  napoleon.docstring.html#_google_typed_arg_regex
  Attribute
  Variable
  PRIVATE
  Undocumented
• napoleon.docstring._numpy_section_regex
  napoleon.docstring.html#_numpy_section_regex
  Attribute
  Variable
  PRIVATE
  Undocumented
• napoleon.docstring._single_colon_regex
  napoleon.docstring.html#_single_colon_regex
  Attribute
  Variable
  PRIVATE
  Undocumented
• napoleon.docstring._xref_or_code_regex
  napoleon.docstring.html#_xref_or_code_regex
  Attribute
  Variable
  PRIVATE
  Undocumented
• napoleon.docstring._xref_regex
  napoleon.docstring.html#_xref_regex
  Attribute
  Variable
  PRIVATE
  Undocumented
• napoleon.docstring._bullet_list_regex
  napoleon.docstring.html#_bullet_list_regex
  Attribute
  Variable
  PRIVATE
  Undocumented
• napoleon.docstring._enumerated_list_regex
  napoleon.docstring.html#_enumerated_list_regex
  Attribute
  Variable
  PRIVATE
  Undocumented
• napoleon.docstring.Field
  napoleon.docstring.Field.html
  Class
  Class
  PUBLIC
  Represent a field with a name and/or a type and/or a description. Commonly a parameter description. It's also used for Returns section and other sections structured with fields.
• napoleon.docstring.Field.name
  napoleon.docstring.Field.html#name
  Attribute
  Instance Variable
  PUBLIC
  The name of the parameter or return value, can be empty. Let's note that Field.name is not the field_name in the docutils sense (i.e. "param" or "type"). But the actual parameter name.
• napoleon.docstring.Field.type
  napoleon.docstring.Field.html#type
  Attribute
  Instance Variable
  PUBLIC
  The enventual type of the parameter/return value.
• napoleon.docstring.Field.content
  napoleon.docstring.Field.html#content
  Attribute
  Instance Variable
  PUBLIC
  The content of the field.
• napoleon.docstring.Field.lineno
  napoleon.docstring.Field.html#lineno
  Attribute
  Instance Variable
  PUBLIC
  Line number of the field relative to the begening of the docstring.
• napoleon.docstring.Field.__bool__
  napoleon.docstring.Field.html#__bool__
  Function
  Method
  PUBLIC
  Returns True if the field has any kind of content.
• napoleon.docstring.is_obj_identifier
  napoleon.docstring.html#is_obj_identifier
  Function
  Function
  PUBLIC
  Is this string a Python object(s) identifier?
• napoleon.docstring.is_type
  napoleon.docstring.html#is_type
  Function
  Function
  PUBLIC
  Is this string a type expression that can be parsed by TypeDocstring without generating any warnings?
• napoleon.docstring.is_google_typed_arg
  napoleon.docstring.html#is_google_typed_arg
  Function
  Function
  PUBLIC
  Is this string a valid type expression and/or google-style field name and type expression in parenthesis?
• napoleon.docstring.TokenType
  napoleon.docstring.TokenType.html
  Class
  Class
  PUBLIC
  Undocumented
• napoleon.docstring.TokenType.LITERAL
  napoleon.docstring.TokenType.html#LITERAL
  Attribute
  Constant
  PUBLIC
  Undocumented
• napoleon.docstring.TokenType.OBJ
  napoleon.docstring.TokenType.html#OBJ
  Attribute
  Constant
  PUBLIC
  Undocumented
• napoleon.docstring.TokenType.DELIMITER
  napoleon.docstring.TokenType.html#DELIMITER
  Attribute
  Constant
  PUBLIC
  Undocumented
• napoleon.docstring.TokenType.CONTROL
  napoleon.docstring.TokenType.html#CONTROL
  Attribute
  Constant
  PUBLIC
  Undocumented
• napoleon.docstring.TokenType.REFERENCE
  napoleon.docstring.TokenType.html#REFERENCE
  Attribute
  Constant
  PUBLIC
  Undocumented
• napoleon.docstring.TokenType.UNKNOWN
  napoleon.docstring.TokenType.html#UNKNOWN
  Attribute
  Constant
  PUBLIC
  Undocumented
• napoleon.docstring.TokenType.ANY
  napoleon.docstring.TokenType.html#ANY
  Attribute
  Constant
  PUBLIC
  Undocumented
• napoleon.docstring._T
  napoleon.docstring.html#_T
  Attribute
  Type Variable
  PRIVATE
  Undocumented
• napoleon.docstring.Token
  napoleon.docstring.Token.html
  Class
  Class
  PUBLIC
  A token in a type specification.
• napoleon.docstring.Token.value
  napoleon.docstring.Token.html#value
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• napoleon.docstring.Token.type
  napoleon.docstring.Token.html#type
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• napoleon.docstring.Token.astext
  napoleon.docstring.Token.html#astext
  Function
  Method
  PUBLIC
  The token as text.
• napoleon.docstring.ITokenizer
  napoleon.docstring.ITokenizer.html
  Class
  Class
  PUBLIC
  A tokenizer for annotations.
• napoleon.docstring.ITokenizer.warnings
  napoleon.docstring.ITokenizer.html#warnings
  Attribute
  Class Variable
  PUBLIC
  The warnings trigered during the tokenization.
• napoleon.docstring.ITokenizer.tokens
  napoleon.docstring.ITokenizer.html#tokens
  Attribute
  Class Variable
  PUBLIC
  The tokens.
• napoleon.docstring.ITokenizer.__init__
  napoleon.docstring.ITokenizer.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• napoleon.docstring.Tokenizer
  napoleon.docstring.Tokenizer.html
  Class
  Class
  PUBLIC
  A tokenizer for string annotations.
• napoleon.docstring.Tokenizer.__init__
  napoleon.docstring.Tokenizer.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• napoleon.docstring.Tokenizer.warnings
  napoleon.docstring.Tokenizer.html#warnings
  Attribute
  Instance Variable
  PUBLIC
  The warnings trigered during the tokenization.
• napoleon.docstring.Tokenizer.tokens
  napoleon.docstring.Tokenizer.html#tokens
  Attribute
  Instance Variable
  PUBLIC
  The tokens.
• napoleon.docstring.Tokenizer._additional_warnings
  napoleon.docstring.Tokenizer.html#_additional_warnings
  Function
  Static Method
  PRIVATE
  Some more warnings.
• napoleon.docstring.Tokenizer.build
  napoleon.docstring.Tokenizer.html#build
  Function
  Class Method
  PUBLIC
  Undocumented
• napoleon.docstring.Tokenizer.recombine_sets
  napoleon.docstring.Tokenizer.html#recombine_sets
  Function
  Static Method
  PUBLIC
  Merge the special literal choices tokens together.
• napoleon.docstring.Tokenizer.tokenize_str
  napoleon.docstring.Tokenizer.html#tokenize_str
  Function
  Static Method
  PUBLIC
  Split the string in tokens for further processing.
• napoleon.docstring.Tokenizer._token_type
  napoleon.docstring.Tokenizer.html#_token_type
  Function
  Static Method
  PRIVATE
  Find the type of a token. Types are defined in TokenType enum.
• napoleon.docstring.TypeDocstring
  napoleon.docstring.TypeDocstring.html
  Class
  Class
  PUBLIC
  Convert natural language type strings to reStructuredText.
• napoleon.docstring.TypeDocstring._natural_language_delimiters_regex_str
  napoleon.docstring.TypeDocstring.html#_natural_language_delimiters_regex_str
  Attribute
  Class Variable
  PRIVATE
  Undocumented
• napoleon.docstring.TypeDocstring._natural_language_delimiters_regex
  napoleon.docstring.TypeDocstring.html#_natural_language_delimiters_regex
  Attribute
  Class Variable
  PRIVATE
  Undocumented
• napoleon.docstring.TypeDocstring._ast_like_delimiters_regex_str
  napoleon.docstring.TypeDocstring.html#_ast_like_delimiters_regex_str
  Attribute
  Class Variable
  PRIVATE
  Undocumented
• napoleon.docstring.TypeDocstring._ast_like_delimiters_regex
  napoleon.docstring.TypeDocstring.html#_ast_like_delimiters_regex
  Attribute
  Class Variable
  PRIVATE
  Undocumented
• napoleon.docstring.TypeDocstring._token_regex
  napoleon.docstring.TypeDocstring.html#_token_regex
  Attribute
  Class Variable
  PRIVATE
  Undocumented
• napoleon.docstring.TypeDocstring._default_regex
  napoleon.docstring.TypeDocstring.html#_default_regex
  Attribute
  Class Variable
  PRIVATE
  Undocumented
• napoleon.docstring.TypeDocstring.__init__
  napoleon.docstring.TypeDocstring.html#__init__
  Function
  Method
  PUBLIC
  Undocumented
• napoleon.docstring.TypeDocstring._tokens
  napoleon.docstring.TypeDocstring.html#_tokens
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• napoleon.docstring.TypeDocstring.warnings
  napoleon.docstring.TypeDocstring.html#warnings
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• napoleon.docstring.TypeDocstring.__str__
  napoleon.docstring.TypeDocstring.html#__str__
  Function
  Method
  PUBLIC
  No summary
• napoleon.docstring.TypeDocstring._convert_type_spec_to_rst
  napoleon.docstring.TypeDocstring.html#_convert_type_spec_to_rst
  Function
  Static Method
  PRIVATE
  Undocumented
• napoleon.docstring.FreeFormException
  napoleon.docstring.FreeFormException.html
  Class
  Exception
  PUBLIC
  Exception to encapsulate the converted lines when numpy-style fields get treated as free form.
• napoleon.docstring.FreeFormException.lines
  napoleon.docstring.FreeFormException.html#lines
  Attribute
  Instance Variable
  PUBLIC
  Undocumented
• napoleon.docstring.GoogleDocstring
  napoleon.docstring.GoogleDocstring.html
  Class
  Class
  PUBLIC
  Convert Google style docstrings to reStructuredText.
• napoleon.docstring.GoogleDocstring._name_rgx
  napoleon.docstring.GoogleDocstring.html#_name_rgx
  Attribute
  Class Variable
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring.__init__
  napoleon.docstring.GoogleDocstring.html#__init__
  Function
  Method
  PUBLIC
  No summary
• napoleon.docstring.GoogleDocstring._what
  napoleon.docstring.GoogleDocstring.html#_what
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._process_type_fields
  napoleon.docstring.GoogleDocstring.html#_process_type_fields
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._line_iter
  napoleon.docstring.GoogleDocstring.html#_line_iter
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._parsed_lines
  napoleon.docstring.GoogleDocstring.html#_parsed_lines
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._is_in_section
  napoleon.docstring.GoogleDocstring.html#_is_in_section
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._section_indent
  napoleon.docstring.GoogleDocstring.html#_section_indent
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._sections
  napoleon.docstring.GoogleDocstring.html#_sections
  Attribute
  Instance Variable
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring.warnings
  napoleon.docstring.GoogleDocstring.html#warnings
  Attribute
  Instance Variable
  PUBLIC
  Warning messages triggered during the conversion.
• napoleon.docstring.GoogleDocstring.__str__
  napoleon.docstring.GoogleDocstring.html#__str__
  Function
  Method
  PUBLIC
  Return the parsed docstring in reStructuredText format.
• napoleon.docstring.GoogleDocstring.lines
  napoleon.docstring.GoogleDocstring.html#lines
  Function
  Method
  PUBLIC
  Return the parsed lines of the docstring in reStructuredText format.
• napoleon.docstring.GoogleDocstring._consume_indented_block
  napoleon.docstring.GoogleDocstring.html#_consume_indented_block
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._consume_contiguous
  napoleon.docstring.GoogleDocstring.html#_consume_contiguous
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._consume_empty
  napoleon.docstring.GoogleDocstring.html#_consume_empty
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._consume_field
  napoleon.docstring.GoogleDocstring.html#_consume_field
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._consume_fields
  napoleon.docstring.GoogleDocstring.html#_consume_fields
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._consume_inline_attribute
  napoleon.docstring.GoogleDocstring.html#_consume_inline_attribute
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._consume_returns_section
  napoleon.docstring.GoogleDocstring.html#_consume_returns_section
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._consume_section_header
  napoleon.docstring.GoogleDocstring.html#_consume_section_header
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._consume_to_end
  napoleon.docstring.GoogleDocstring.html#_consume_to_end
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._consume_to_next_section
  napoleon.docstring.GoogleDocstring.html#_consume_to_next_section
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._convert_type
  napoleon.docstring.GoogleDocstring.html#_convert_type
  Function
  Method
  PRIVATE
  Tokenize the string type and convert it with additional markup and auto linking, with L{TypeDocstring}.
• napoleon.docstring.GoogleDocstring._dedent
  napoleon.docstring.GoogleDocstring.html#_dedent
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._escape_args_and_kwargs
  napoleon.docstring.GoogleDocstring.html#_escape_args_and_kwargs
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._fix_field_desc
  napoleon.docstring.GoogleDocstring.html#_fix_field_desc
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._format_admonition
  napoleon.docstring.GoogleDocstring.html#_format_admonition
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._format_block
  napoleon.docstring.GoogleDocstring.html#_format_block
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._format_docutils_params
  napoleon.docstring.GoogleDocstring.html#_format_docutils_params
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._format_field
  napoleon.docstring.GoogleDocstring.html#_format_field
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._format_fields
  napoleon.docstring.GoogleDocstring.html#_format_fields
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._get_current_indent
  napoleon.docstring.GoogleDocstring.html#_get_current_indent
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._get_indent
  napoleon.docstring.GoogleDocstring.html#_get_indent
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._get_initial_indent
  napoleon.docstring.GoogleDocstring.html#_get_initial_indent
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._get_min_indent
  napoleon.docstring.GoogleDocstring.html#_get_min_indent
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._indent
  napoleon.docstring.GoogleDocstring.html#_indent
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._is_indented
  napoleon.docstring.GoogleDocstring.html#_is_indented
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._is_list
  napoleon.docstring.GoogleDocstring.html#_is_list
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._is_section_header
  napoleon.docstring.GoogleDocstring.html#_is_section_header
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._is_section_break
  napoleon.docstring.GoogleDocstring.html#_is_section_break
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._parse
  napoleon.docstring.GoogleDocstring.html#_parse
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._parse_admonition
  napoleon.docstring.GoogleDocstring.html#_parse_admonition
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._parse_attribute_docstring
  napoleon.docstring.GoogleDocstring.html#_parse_attribute_docstring
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._parse_attributes_section
  napoleon.docstring.GoogleDocstring.html#_parse_attributes_section
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._parse_examples_section
  napoleon.docstring.GoogleDocstring.html#_parse_examples_section
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._parse_generic_section
  napoleon.docstring.GoogleDocstring.html#_parse_generic_section
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._parse_keyword_arguments_section
  napoleon.docstring.GoogleDocstring.html#_parse_keyword_arguments_section
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._parse_methods_section
  napoleon.docstring.GoogleDocstring.html#_parse_methods_section
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._parse_notes_section
  napoleon.docstring.GoogleDocstring.html#_parse_notes_section
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._parse_parameters_section
  napoleon.docstring.GoogleDocstring.html#_parse_parameters_section
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._parse_raises_section
  napoleon.docstring.GoogleDocstring.html#_parse_raises_section
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._parse_references_section
  napoleon.docstring.GoogleDocstring.html#_parse_references_section
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._parse_returns_section
  napoleon.docstring.GoogleDocstring.html#_parse_returns_section
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._parse_see_also_section
  napoleon.docstring.GoogleDocstring.html#_parse_see_also_section
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._parse_warns_section
  napoleon.docstring.GoogleDocstring.html#_parse_warns_section
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._partition_field_on_colon
  napoleon.docstring.GoogleDocstring.html#_partition_field_on_colon
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.GoogleDocstring._partition_multiline_field_on_colon
  napoleon.docstring.GoogleDocstring.html#_partition_multiline_field_on_colon
  Function
  Method
  PRIVATE
  Partition multiple lines on colon. If the type or name span multiple lines, they will be automatically joined.
• napoleon.docstring.GoogleDocstring._strip_empty
  napoleon.docstring.GoogleDocstring.html#_strip_empty
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.NumpyDocstring
  napoleon.docstring.NumpyDocstring.html
  Class
  Class
  PUBLIC
  Convert NumPy style docstrings to reStructuredText.
• napoleon.docstring.NumpyDocstring._escape_args_and_kwargs
  napoleon.docstring.NumpyDocstring.html#_escape_args_and_kwargs
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.NumpyDocstring._consume_field
  napoleon.docstring.NumpyDocstring.html#_consume_field
  Function
  Method
  PRIVATE
  No summary
• napoleon.docstring.NumpyDocstring._consume_fields
  napoleon.docstring.NumpyDocstring.html#_consume_fields
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.NumpyDocstring._consume_returns_section
  napoleon.docstring.NumpyDocstring.html#_consume_returns_section
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.NumpyDocstring._consume_section_header
  napoleon.docstring.NumpyDocstring.html#_consume_section_header
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.NumpyDocstring._is_section_break
  napoleon.docstring.NumpyDocstring.html#_is_section_break
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.NumpyDocstring._is_section_header
  napoleon.docstring.NumpyDocstring.html#_is_section_header
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.NumpyDocstring._convert_type_and_maybe_consume_free_form_field
  napoleon.docstring.NumpyDocstring.html#_convert_type_and_maybe_consume_free_form_field
  Function
  Method
  PRIVATE
  Same as _convert_type, but can raise FreeFormException.
• napoleon.docstring.NumpyDocstring._parse_see_also_section
  napoleon.docstring.NumpyDocstring.html#_parse_see_also_section
  Function
  Method
  PRIVATE
  Undocumented
• napoleon.docstring.NumpyDocstring._parse_numpydoc_see_also_section
  napoleon.docstring.NumpyDocstring.html#_parse_numpydoc_see_also_section
  Function
  Method
  PRIVATE
  Derived from the NumpyDoc implementation of _parse_see_also.
• napoleon.docstring.Field.__init__
  napoleon.docstring.Field.html#__init__
  Function
  Method
  PUBLIC
  attrs generated method
• napoleon.docstring.Token.__init__
  napoleon.docstring.Token.html#__init__
  Function
  Method
  PUBLIC
  attrs generated method
• napoleon.docstring.FreeFormException.__init__
  napoleon.docstring.FreeFormException.html#__init__
  Function
  Method
  PUBLIC
  attrs generated method