docstring_parser API Documentation Modules Classes Names
Clear Help

For more information on the search, visit the help page.

Class Hierarchy

  • ast.NodeVisitor
    • docstring_parser.attrdoc.AttributeDocstrings - An ast.NodeVisitor that collects attribute docstrings.
  • docstring_parser.Docstring - Docstring object representation.
  • docstring_parser.DocstringMeta - Docstring meta information.
    • docstring_parser.common.DocstringExample - DocstringMeta symbolizing example metadata.
    • docstring_parser.DocstringDeprecated - DocstringMeta symbolizing deprecation metadata.
    • docstring_parser.DocstringParam - DocstringMeta symbolizing :param metadata.
    • docstring_parser.DocstringRaises - DocstringMeta symbolizing :raises metadata.
    • docstring_parser.DocstringReturns - DocstringMeta symbolizing :returns or :yields metadata.
  • docstring_parser.google.GoogleParser - Parser for Google-style docstrings.
  • docstring_parser.numpydoc.NumpydocParser - Parser for numpydoc-style docstrings.
  • docstring_parser.numpydoc.Section - Numpydoc section parser.
    • docstring_parser.numpydoc._KVSection - Base parser for numpydoc sections with key-value syntax.
      • docstring_parser.numpydoc.ParamSection - Parser for numpydoc parameter sections.
      • docstring_parser.numpydoc.RaisesSection - Parser for numpydoc raises sections.
      • docstring_parser.numpydoc.ReturnsSection - Parser for numpydoc returns sections.
        • docstring_parser.numpydoc.YieldsSection - Parser for numpydoc generator "yields" sections.
    • docstring_parser.numpydoc._SphinxSection - Base parser for numpydoc sections with sphinx-style syntax.
      • docstring_parser.numpydoc.DeprecationSection - Parser for numpydoc "deprecation warning" sections.
    • docstring_parser.numpydoc.ExamplesSection - Parser for numpydoc examples sections.
  • enum.Enum
    • docstring_parser.DocstringStyle - Docstring style.
    • docstring_parser.RenderingStyle - Rendering style when unparsing parsed docstrings.
  • enum.IntEnum
    • docstring_parser.google.SectionType - Types of sections.
  • namedtuple('SectionBase', 'title key type')
    • docstring_parser.google.Section - A docstring section.
  • RuntimeError
    • docstring_parser.ParseError - Base class for all parsing related errors.
API Documentation for docstring_parser, generated by pydoctor 25.10.1 at 2026-06-30 05:43:49.