Google Docformatter

Navigation

Contents:

  • Installation
  • Usage
  • Configuration
  • API
    • g_docformatter

Related Topics

  • Documentation overview
    • API
      • Previous: API
      • Next: g_docformatter.cli

g_docformatterΒΆ

Package for formatting Google-style docstrings.

Submodules

  • g_docformatter.cli
    • ContainerGroup
    • FormatterSettingsInjectionCommand
  • g_docformatter.collectors
    • Paragraph
    • CollectorContext
    • CollectorMethodContextError
    • TokenCollectorMeta
    • TokenCollectorABC
    • collector_method
    • RootCollector
    • BodyTokenCollector
    • StdSectionTokenCollector
    • ListSectionTokenCollector
    • SphinxCodeBlockTokenCollector
  • g_docformatter.container
    • TextFormattersContainer
    • TokenCollectorsContainer
    • ParagraphFormattersContainer
    • TokenizerContainer
    • ApplicationContainer
  • g_docformatter.formatters
    • g_docformatter.formatters.paragraph
    • g_docformatter.formatters.text
    • g_docformatter.formatters.types
  • g_docformatter.parse
    • get_docstrings()
    • DocstringToken
    • tokenize_docstring()
  • g_docformatter.tokens
    • SubclassedTokenEnumMeta
    • BaseTokenEnum
    • get_tokenizer_regex()
    • DocstringSyntaxTokens
    • REPLCodeTokens
    • AllSectionTokens
    • StandardSectionTokens
    • ListSectionTokens
    • SphinxSectionTokens
  • g_docformatter.types
    • FrozenParagraph
    • ParagraphArgument
  • g_docformatter.untokenize
    • untokenize()
©2025, Cory Laughlin. | Powered by Sphinx 9.1.0 & Alabaster 1.0.0 | Page source