python

Documentation

Index

• type PythonExtractor
  • func NewPythonExtractor(runner site.CommandRunner) *PythonExtractor
  • func (p *PythonExtractor) Extract(ctx context.Context, req *extractors.ExtractRequest) (*extractors.ExtractResult, error)
  • func (p *PythonExtractor) Language() extractors.Language
  • func (p *PythonExtractor) Validate(ctx context.Context) error

Types

type PythonExtractor

type PythonExtractor struct {
	// contains filtered or unexported fields
}

PythonExtractor extracts documentation from Python source code using pydoc-markdown

func NewPythonExtractor

func NewPythonExtractor(runner site.CommandRunner) *PythonExtractor

NewPythonExtractor creates a new Python documentation extractor

func (*PythonExtractor) Extract

func (p *PythonExtractor) Extract(ctx context.Context, req *extractors.ExtractRequest) (*extractors.ExtractResult, error)

Extract generates documentation from Python source code

func (*PythonExtractor) Language

func (p *PythonExtractor) Language() extractors.Language

Language returns the language this extractor handles

func (*PythonExtractor) Validate

func (p *PythonExtractor) Validate(ctx context.Context) error

Validate checks if pydoc-markdown is available.

Only a genuine lookup failure means the tool is unavailable; an installed pydoc-markdown that exits non-zero is an extraction error, not a skip.