Index

A

additional_indent (g_docformatter.formatters.paragraph.BodyParagraphFormatter attribute) (g_docformatter.formatters.paragraph.SphinxCodeBlockParagraphFormatter attribute)

AllSectionTokens (class in g_docformatter.tokens) ApplicationContainer (class in g_docformatter.container) AsIsTextFormatter (class in g_docformatter.formatters.text)

B

base_indent (g_docformatter.collectors.CollectorContext attribute) BaseTokenEnum (class in g_docformatter.tokens) BlackTextFormatter (class in g_docformatter.formatters.text)

BODY (g_docformatter.collectors.StdSectionTokenCollector attribute) BodyParagraphFormatter (class in g_docformatter.formatters.paragraph) BodyTokenCollector (class in g_docformatter.collectors)

C

clear_state() (g_docformatter.collectors.CollectorContext method) CODE (g_docformatter.collectors.SphinxCodeBlockTokenCollector attribute) collect_and_finalize_header() (g_docformatter.collectors.ListSectionTokenCollector method) (g_docformatter.collectors.SphinxCodeBlockTokenCollector method) (g_docformatter.collectors.StdSectionTokenCollector method) collect_and_finalize_options() (g_docformatter.collectors.SphinxCodeBlockTokenCollector method) collect_code() (g_docformatter.collectors.SphinxCodeBlockTokenCollector method) collect_current_paragraph_token() (g_docformatter.collectors.BodyTokenCollector method) (g_docformatter.collectors.ListSectionTokenCollector method)

collect_remaining_tokens() (g_docformatter.collectors.StdSectionTokenCollector method) collect_tokens() (g_docformatter.collectors.TokenCollectorABC method) collector_method (in module g_docformatter.collectors) CollectorContext (class in g_docformatter.collectors) CollectorMethodContextError ContainerGroup (class in g_docformatter.cli) current_paragraph (g_docformatter.collectors.CollectorContext attribute)

D

DESCRIPTION (g_docformatter.collectors.RootCollector attribute)

DocstringSyntaxTokens (class in g_docformatter.tokens) DocstringToken (class in g_docformatter.parse)

E

EOD (g_docformatter.collectors.RootCollector attribute)

F

finalize_current() (g_docformatter.collectors.CollectorContext method) finalize_current_paragraph() (g_docformatter.collectors.BodyTokenCollector method) (g_docformatter.collectors.ListSectionTokenCollector method) (g_docformatter.collectors.RootCollector method) format_code_paragraph() (g_docformatter.formatters.paragraph.SphinxCodeBlockParagraphFormatter method) format_eod_paragraph() (g_docformatter.formatters.paragraph.RootParagraphFormatter method) format_header_paragraph() (g_docformatter.formatters.paragraph.ListSectionParagraphFormatter method) (g_docformatter.formatters.paragraph.SphinxCodeBlockParagraphFormatter method) (g_docformatter.formatters.paragraph.StdSectionParagraphFormatter method) format_list_item_body_paragraph() (g_docformatter.formatters.paragraph.ListSectionParagraphFormatter method) format_list_item_paragraph() (g_docformatter.formatters.paragraph.ListSectionParagraphFormatter method) format_option_paragraph() (g_docformatter.formatters.paragraph.SphinxCodeBlockParagraphFormatter method) format_repl_code_paragraph() (g_docformatter.formatters.paragraph.BodyParagraphFormatter method) format_summary_only_paragraph() (g_docformatter.formatters.paragraph.RootParagraphFormatter method) format_summary_paragraph() (g_docformatter.formatters.paragraph.RootParagraphFormatter method) format_text() (g_docformatter.formatters.text.AsIsTextFormatter method) (g_docformatter.formatters.text.BlackTextFormatter method) (g_docformatter.formatters.text.HangingIndentTextFormatter method) (g_docformatter.formatters.text.IndentOnlyTextFormatter method) (g_docformatter.formatters.text.InverseHangingIndentTextFormatter method) (g_docformatter.formatters.text.TextFormatterABC method) (g_docformatter.formatters.text.UniformIndentTextFormatter method)

format_text_paragraph() (g_docformatter.formatters.paragraph.BodyParagraphFormatter method) format_tokens() (g_docformatter.formatters.paragraph.ParagraphFormatterABC method) formatter_method (in module g_docformatter.formatters.paragraph) FormatterCallableProtocol (class in g_docformatter.formatters.types) formatters (g_docformatter.formatters.paragraph.ListSectionParagraphFormatter attribute) (g_docformatter.formatters.paragraph.ParagraphFormatterABC attribute) (g_docformatter.formatters.paragraph.RootParagraphFormatter attribute) (g_docformatter.formatters.paragraph.StdSectionParagraphFormatter attribute) FormatterSettings (class in g_docformatter.formatters.types) FormatterSettingsInjectionCommand (class in g_docformatter.cli) FrozenParagraph (in module g_docformatter.types)

G

g_docformatter module g_docformatter.cli module g_docformatter.collectors module g_docformatter.container module g_docformatter.formatters module g_docformatter.formatters.paragraph module g_docformatter.formatters.text module g_docformatter.formatters.types module g_docformatter.parse module

g_docformatter.tokens module g_docformatter.types module g_docformatter.untokenize module GENERAL_TOKEN_TYPES (g_docformatter.collectors.RootCollector attribute) get_base_indent() (g_docformatter.formatters.paragraph.ParagraphFormatterABC method) get_base_indent_level() (g_docformatter.formatters.paragraph.ParagraphFormatterABC method) get_docstrings() (in module g_docformatter.parse) get_text_formatter() (g_docformatter.formatters.paragraph.ParagraphFormatterABC method) get_token_indent() (g_docformatter.collectors.TokenCollectorABC method) get_token_indent_diff() (g_docformatter.collectors.TokenCollectorABC method) get_token_indent_level_diff() (g_docformatter.collectors.TokenCollectorABC method) get_token_text() (g_docformatter.formatters.paragraph.ParagraphFormatterABC method) get_tokenizer_regex() (in module g_docformatter.tokens)

H

HangingIndentTextFormatter (class in g_docformatter.formatters.text) HEADER (g_docformatter.collectors.ListSectionTokenCollector attribute) (g_docformatter.collectors.SphinxCodeBlockTokenCollector attribute) (g_docformatter.collectors.StdSectionTokenCollector attribute)

I

indent_size (g_docformatter.formatters.types.FormatterSettings attribute) IndentOnlyTextFormatter (class in g_docformatter.formatters.text)

InverseHangingIndentTextFormatter (class in g_docformatter.formatters.text) invoke() (g_docformatter.cli.ContainerGroup method) (g_docformatter.cli.FormatterSettingsInjectionCommand method)

J

join_with (g_docformatter.formatters.paragraph.BodyParagraphFormatter property) (g_docformatter.formatters.paragraph.ListSectionParagraphFormatter property) (g_docformatter.formatters.paragraph.ParagraphFormatterABC property) (g_docformatter.formatters.paragraph.RootParagraphFormatter property) (g_docformatter.formatters.paragraph.SphinxCodeBlockParagraphFormatter property) (g_docformatter.formatters.paragraph.StdSectionParagraphFormatter property)

L

line (g_docformatter.parse.DocstringToken attribute) LIST_ITEM (g_docformatter.collectors.ListSectionTokenCollector attribute) LIST_ITEM_BODY (g_docformatter.collectors.ListSectionTokenCollector attribute)

LIST_SECTION (g_docformatter.collectors.RootCollector attribute) ListSectionParagraphFormatter (class in g_docformatter.formatters.paragraph) ListSectionTokenCollector (class in g_docformatter.collectors) ListSectionTokens (class in g_docformatter.tokens)

M

module g_docformatter g_docformatter.cli g_docformatter.collectors g_docformatter.container g_docformatter.formatters g_docformatter.formatters.paragraph g_docformatter.formatters.text g_docformatter.formatters.types g_docformatter.parse g_docformatter.tokens g_docformatter.types g_docformatter.untokenize

O

OPTION (g_docformatter.collectors.SphinxCodeBlockTokenCollector attribute)

P

paragraph (g_docformatter.formatters.types.FormatterSettings attribute) Paragraph (in module g_docformatter.collectors) ParagraphArgument (in module g_docformatter.types) ParagraphFormatterABC (class in g_docformatter.formatters.paragraph) ParagraphFormatterABC.FormatterMethod (class in g_docformatter.formatters.paragraph)

ParagraphFormatterError ParagraphFormattersContainer (class in g_docformatter.container) paragraphs (g_docformatter.collectors.CollectorContext attribute) process_current_paragraph_token() (g_docformatter.collectors.RootCollector method) process_eod_token() (g_docformatter.collectors.RootCollector method) process_summary_only_docstring() (g_docformatter.collectors.RootCollector method)

R

REPL_CODE (g_docformatter.collectors.BodyTokenCollector attribute) REPLCodeTokens (class in g_docformatter.tokens) required_subformatters (g_docformatter.formatters.paragraph.BodyParagraphFormatter attribute) (g_docformatter.formatters.paragraph.ListSectionParagraphFormatter attribute) (g_docformatter.formatters.paragraph.ParagraphFormatterABC attribute) (g_docformatter.formatters.paragraph.RootParagraphFormatter attribute) (g_docformatter.formatters.paragraph.StdSectionParagraphFormatter attribute)

RootCollector (class in g_docformatter.collectors) RootParagraphFormatter (class in g_docformatter.formatters.paragraph)

S

spaces_to_indent_level() (g_docformatter.collectors.TokenCollectorABC method) SPHINX_CODE (g_docformatter.collectors.BodyTokenCollector attribute) SphinxCodeBlockParagraphFormatter (class in g_docformatter.formatters.paragraph) SphinxCodeBlockTokenCollector (class in g_docformatter.collectors) SphinxSectionTokens (class in g_docformatter.tokens) StandardSectionTokens (class in g_docformatter.tokens) start (g_docformatter.parse.DocstringToken attribute) start_new_paragraph() (g_docformatter.collectors.BodyTokenCollector method) (g_docformatter.collectors.ListSectionTokenCollector method) (g_docformatter.collectors.RootCollector method)

state (g_docformatter.collectors.CollectorContext attribute) STD_SECTION (g_docformatter.collectors.RootCollector attribute) StdSectionParagraphFormatter (class in g_docformatter.formatters.paragraph) StdSectionTokenCollector (class in g_docformatter.collectors) SubclassedTokenEnumMeta (class in g_docformatter.tokens) SUFFIX (g_docformatter.formatters.paragraph.ParagraphFormatterABC attribute) SUMMARY (g_docformatter.collectors.RootCollector attribute) SUMMARY_ONLY (g_docformatter.collectors.RootCollector attribute)

T

TEXT (g_docformatter.collectors.BodyTokenCollector attribute) text (g_docformatter.parse.DocstringToken attribute) TextFormatterABC (class in g_docformatter.formatters.text) TextFormattersContainer (class in g_docformatter.container) TokenCollectorABC (class in g_docformatter.collectors)

TokenCollectorABC.CollectorMethod (class in g_docformatter.collectors) TokenCollectorMeta (class in g_docformatter.collectors) TokenCollectorsContainer (class in g_docformatter.container) tokenize_docstring() (in module g_docformatter.parse) TokenizerContainer (class in g_docformatter.container) type (g_docformatter.parse.DocstringToken attribute)

U

UniformIndentTextFormatter (class in g_docformatter.formatters.text)

untokenize() (in module g_docformatter.untokenize)

W

width (g_docformatter.formatters.types.FormatterSettings attribute)