genpydoc package

Subpackages

• genpydoc.commenter package
  • Submodules
  • genpydoc.commenter.commenter module
    • Commenter
      • Commenter.MODELS_MAPPING
      • Commenter.build_class_prompt()
      • Commenter.build_function_prompt()
      • Commenter.build_prompt()
      • Commenter.comment()
      • Commenter.document()
      • Commenter.openai_process()
      • Commenter.process_prompt()
      • Commenter.process_prompts()
  • genpydoc.commenter.transformer module
    • Parser
      • Parser.post_process()
      • Parser.process()
    • Transformer
      • Transformer.comments
      • Transformer.config
      • Transformer.visit_AsyncFunctionDef()
      • Transformer.visit_ClassDef()
      • Transformer.visit_FunctionDef()
• genpydoc.config package
  • Submodules
  • genpydoc.config.config module
    • Config
      • Config.VALID_LLM_PROVIDERS
      • Config.VALID_STYLES
      • Config.docstring_style
      • Config.exclude
      • Config.ignore_init_method
      • Config.ignore_magic
      • Config.ignore_module
      • Config.ignore_nested_classes
      • Config.ignore_nested_functions
      • Config.ignore_overloaded_functions
      • Config.ignore_private
      • Config.ignore_property_decorators
      • Config.ignore_property_setters
      • Config.ignore_semiprivate
      • Config.include_only_covered
      • Config.post_processing
      • Config.root
      • Config.run_on_diff
      • Config.run_staged
      • Config.target_branch
      • Config.use_llm_provider
      • Config.use_model
    • PostProcessingConfig
      • PostProcessingConfig.cleanup
      • PostProcessingConfig.convert
    • parse_pyproject_toml()
• genpydoc.extractor package
  • Submodules
  • genpydoc.extractor.extract module
    • Extract
      • Extract.COMMON_EXCLUDE
      • Extract.VALID_EXTENSIONS
      • Extract.get_coverage()
      • Extract.get_filenames_from_path()
  • genpydoc.extractor.visit module
    • CovNode
      • CovNode.code
      • CovNode.covered
      • CovNode.docstring
      • CovNode.file
      • CovNode.is_nested_cls
      • CovNode.is_nested_func
      • CovNode.level
      • CovNode.lineno
      • CovNode.name
      • CovNode.node_type
      • CovNode.parent
      • CovNode.path
    • Visitor
      • Visitor.filename
      • Visitor.config
      • Visitor.source
      • Visitor.stack
      • Visitor.nodes
      • Visitor.nodes
      • Visitor.source
      • Visitor.stack
      • Visitor.visit_AsyncFunctionDef()
      • Visitor.visit_ClassDef()
      • Visitor.visit_FunctionDef()
      • Visitor.visit_Module()
• genpydoc.git_retriever package
  • Submodules
  • genpydoc.git_retriever.git_retriever module
    • GitRetriever
      • GitRetriever.extract_diff()
  • genpydoc.git_retriever.utils module
    • ChangeType
      • ChangeType.ADDED
      • ChangeType.DELETED
      • ChangeType.MODIFIED
      • ChangeType.RENAMED
      • ChangeType.TYPE_PATH
    • DiffChange
      • DiffChange.kind
      • DiffChange.new_lineno
      • DiffChange.old_lineno
      • DiffChange.text
    • DiffChangeType
      • DiffChangeType.ADD
      • DiffChangeType.BLANK
      • DiffChangeType.REMOVE
    • branch_exists()
    • extract_sequences()
    • get_change_type()
    • is_git_repo()
    • parse_diff()
    • process_changes()
    • process_git_diff()
    • pull_node_name_from_lineno()
• genpydoc.utils package
  • Submodules
  • genpydoc.utils.utils module
    • find_project_config()
    • find_project_root()
    • get_common_base()
    • parse_pyproject_toml()
    • read_config_file()

Submodules

genpydoc.cli module

genpydoc.documenter module

class genpydoc.documenter.Documenter(config: Config)

Bases: object

config: Config

document(paths)