Class Hierarchy
enum.Enumnapoleon.docstring.TokenType- Undocumented
Exceptionnapoleon.docstring.FreeFormException- Exception to encapsulate the converted lines when numpy-style fields get treated as free form.numpy_demo.ExampleError- Exceptions are documented in the same way as classes.
napoleon.docstring.Field- 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.GoogleDocstring- Convert Google style docstrings to reStructuredText.napoleon.docstring.NumpyDocstring- Convert NumPy style docstrings to reStructuredText.
napoleon.docstring.Token- A token in a type specification.napoleon.docstring.TypeDocstring- Convert natural language type strings to reStructuredText.numpy_demo.ExampleClass- The summary line for a class docstring should fit on one line.typing.Genericnapoleon.iterators.peek_iter- An iterator object that supports peeking ahead.napoleon.iterators.modify_iter- An iterator object that supports modifying items as they are returned.
typing.Protocolnapoleon.docstring.ITokenizer- A tokenizer for annotations.napoleon.docstring.Tokenizer- A tokenizer for string annotations.