Index of Names

A

A - B - C - D - E - G - I - K - L - M - N - P - R - S - T - U - V - Y - _

add_attribute_docstrings - docstring_parser.attrdoc.add_attribute_docstrings
add_section
- docstring_parser.google.GoogleParser.add_section
- docstring_parser.numpydoc.NumpydocParser.add_section
arg_name - docstring_parser.DocstringParam.arg_name
args - docstring_parser.DocstringMeta.args
ast_get_attribute - docstring_parser.attrdoc.ast_get_attribute
ast_get_constant_value - docstring_parser.attrdoc.ast_get_constant_value
ast_is_literal_str - docstring_parser.attrdoc.ast_is_literal_str
ast_unparse - docstring_parser.attrdoc.ast_unparse
attr_docs - docstring_parser.attrdoc.AttributeDocstrings.attr_docs
attrdoc - docstring_parser.attrdoc
AttributeDocstrings - docstring_parser.attrdoc.AttributeDocstrings
AUTO - docstring_parser.DocstringStyle.AUTO

B

A - B - C - D - E - G - I - K - L - M - N - P - R - S - T - U - V - Y - _

blank_after_long_description - docstring_parser.Docstring.blank_after_long_description
blank_after_short_description - docstring_parser.Docstring.blank_after_short_description

C

A - B - C - D - E - G - I - K - L - M - N - P - R - S - T - U - V - Y - _

CLEAN - docstring_parser.RenderingStyle.CLEAN
combine_docstrings - docstring_parser.combine_docstrings
common - docstring_parser.common
COMPACT - docstring_parser.RenderingStyle.COMPACT
compose

D

A - B - C - D - E - G - I - K - L - M - N - P - R - S - T - U - V - Y - _

default - docstring_parser.DocstringParam.default
DEFAULT_SECTIONS
- docstring_parser.google.DEFAULT_SECTIONS
- docstring_parser.numpydoc.DEFAULT_SECTIONS
deprecation - docstring_parser.Docstring.deprecation
DEPRECATION_KEYWORDS - docstring_parser.common.DEPRECATION_KEYWORDS
DeprecationSection - docstring_parser.numpydoc.DeprecationSection
description
Docstring - docstring_parser.Docstring
docstring_parser - docstring_parser
DocstringDeprecated - docstring_parser.DocstringDeprecated
DocstringExample - docstring_parser.common.DocstringExample
DocstringMeta - docstring_parser.DocstringMeta
DocstringParam - docstring_parser.DocstringParam
DocstringRaises - docstring_parser.DocstringRaises
DocstringReturns - docstring_parser.DocstringReturns
DocstringStyle - docstring_parser.DocstringStyle

E

A - B - C - D - E - G - I - K - L - M - N - P - R - S - T - U - V - Y - _

EPYDOC - docstring_parser.DocstringStyle.EPYDOC
epydoc - docstring_parser.epydoc
examples - docstring_parser.Docstring.examples
EXAMPLES_KEYWORDS - docstring_parser.common.EXAMPLES_KEYWORDS
ExamplesSection - docstring_parser.numpydoc.ExamplesSection
EXPANDED - docstring_parser.RenderingStyle.EXPANDED

G

A - B - C - D - E - G - I - K - L - M - N - P - R - S - T - U - V - Y - _

get_attr_docs - docstring_parser.attrdoc.AttributeDocstrings.get_attr_docs
GOOGLE - docstring_parser.DocstringStyle.GOOGLE
google - docstring_parser.google
GOOGLE_ARG_DESC_REGEX - docstring_parser.google.GOOGLE_ARG_DESC_REGEX
GOOGLE_TYPED_ARG_REGEX - docstring_parser.google.GOOGLE_TYPED_ARG_REGEX
GoogleParser - docstring_parser.google.GoogleParser

I

A - B - C - D - E - G - I - K - L - M - N - P - R - S - T - U - V - Y - _

is_generator
is_optional - docstring_parser.DocstringParam.is_optional

K

A - B - C - D - E - G - I - K - L - M - N - P - R - S - T - U - V - Y - _

key - docstring_parser.numpydoc.Section.key
KV_REGEX - docstring_parser.numpydoc.KV_REGEX

L

A - B - C - D - E - G - I - K - L - M - N - P - R - S - T - U - V - Y - _

long_description - docstring_parser.Docstring.long_description

M

A - B - C - D - E - G - I - K - L - M - N - P - R - S - T - U - V - Y - _

many_returns - docstring_parser.Docstring.many_returns
meta - docstring_parser.Docstring.meta
MULTIPLE - docstring_parser.google.SectionType.MULTIPLE
MULTIPLE_PATTERN - docstring_parser.google.MULTIPLE_PATTERN

N

A - B - C - D - E - G - I - K - L - M - N - P - R - S - T - U - V - Y - _

NUMPYDOC - docstring_parser.DocstringStyle.NUMPYDOC
numpydoc - docstring_parser.numpydoc
NumpydocParser - docstring_parser.numpydoc.NumpydocParser

P

A - B - C - D - E - G - I - K - L - M - N - P - R - S - T - U - V - Y - _

PARAM_DEFAULT_REGEX - docstring_parser.numpydoc.PARAM_DEFAULT_REGEX
PARAM_DEFAULT_REGEX_IN_DESC - docstring_parser.numpydoc.PARAM_DEFAULT_REGEX_IN_DESC
PARAM_KEY_REGEX - docstring_parser.numpydoc.PARAM_KEY_REGEX
PARAM_KEYWORDS - docstring_parser.common.PARAM_KEYWORDS
PARAM_OPTIONAL_REGEX - docstring_parser.numpydoc.PARAM_OPTIONAL_REGEX
params - docstring_parser.Docstring.params
ParamSection - docstring_parser.numpydoc.ParamSection
parse
parse_from_object - docstring_parser.parse_from_object
ParseError - docstring_parser.ParseError
parser - docstring_parser.parser
prev_attr - docstring_parser.attrdoc.AttributeDocstrings.prev_attr

R

A - B - C - D - E - G - I - K - L - M - N - P - R - S - T - U - V - Y - _

raises - docstring_parser.Docstring.raises
RAISES_KEYWORDS - docstring_parser.common.RAISES_KEYWORDS
RaisesSection - docstring_parser.numpydoc.RaisesSection
RenderingStyle - docstring_parser.RenderingStyle
REST - docstring_parser.DocstringStyle.REST
rest - docstring_parser.rest
RETURN_KEY_REGEX - docstring_parser.numpydoc.RETURN_KEY_REGEX
return_name - docstring_parser.DocstringReturns.return_name
returns - docstring_parser.Docstring.returns
RETURNS_KEYWORDS - docstring_parser.common.RETURNS_KEYWORDS
ReturnsSection - docstring_parser.numpydoc.ReturnsSection

S

A - B - C - D - E - G - I - K - L - M - N - P - R - S - T - U - V - Y - _

Section
- docstring_parser.google.Section
- docstring_parser.numpydoc.Section
sections
- docstring_parser.google.GoogleParser.sections
- docstring_parser.numpydoc.NumpydocParser.sections
SectionType - docstring_parser.google.SectionType
short_description - docstring_parser.Docstring.short_description
SINGULAR - docstring_parser.google.SectionType.SINGULAR
SINGULAR_OR_MULTIPLE - docstring_parser.google.SectionType.SINGULAR_OR_MULTIPLE
snippet - docstring_parser.common.DocstringExample.snippet
style - docstring_parser.Docstring.style

T

A - B - C - D - E - G - I - K - L - M - N - P - R - S - T - U - V - Y - _

title - docstring_parser.numpydoc.Section.title
title_colon - docstring_parser.google.GoogleParser.title_colon
title_pattern
- docstring_parser.numpydoc._SphinxSection.title_pattern
- docstring_parser.numpydoc.Section.title_pattern
titles_re
- docstring_parser.google.GoogleParser.titles_re
- docstring_parser.numpydoc.NumpydocParser.titles_re
type_name

U

A - B - C - D - E - G - I - K - L - M - N - P - R - S - T - U - V - Y - _

util - docstring_parser.util

V

A - B - C - D - E - G - I - K - L - M - N - P - R - S - T - U - V - Y - _

version - docstring_parser.DocstringDeprecated.version
visit - docstring_parser.attrdoc.AttributeDocstrings.visit

Y

A - B - C - D - E - G - I - K - L - M - N - P - R - S - T - U - V - Y - _

YIELDS_KEYWORDS - docstring_parser.common.YIELDS_KEYWORDS
YieldsSection - docstring_parser.numpydoc.YieldsSection

_

A - B - C - D - E - G - I - K - L - M - N - P - R - S - T - U - V - Y - _

__init__
_build_meta
- docstring_parser.google.GoogleParser._build_meta
- docstring_parser.rest._build_meta
_build_multi_meta - docstring_parser.google.GoogleParser._build_multi_meta
_build_single_meta - docstring_parser.google.GoogleParser._build_single_meta
_clean_str
- docstring_parser.epydoc._clean_str
- docstring_parser.numpydoc._clean_str
_Func - docstring_parser.util._Func
_KVSection - docstring_parser.numpydoc._KVSection
_pairwise - docstring_parser.numpydoc._pairwise
_parse_item
_setup
- docstring_parser.google.GoogleParser._setup
- docstring_parser.numpydoc.NumpydocParser._setup
_SphinxSection - docstring_parser.numpydoc._SphinxSection
_STYLE_MAP - docstring_parser.parser._STYLE_MAP