pydoctor.epydoc.markup.SummaryExtractor

class documentation

class SummaryExtractor(nodes.NodeVisitor): (source)

Constructor: SummaryExtractor(document, maxchars)

View In Hierarchy

A docutils node visitor that extracts first sentences from the first paragraph in a document.

Method __init__ No summary
Method unknown_visit Ignore all unknown nodes
Method visit_document Undocumented
Method visit_field Undocumented
Method visit_paragraph Undocumented
Instance Variable maxchars Undocumented
Instance Variable other_docs Undocumented
Instance Variable summary Undocumented
Constant _SENTENCE_RE_SPLIT Undocumented
def __init__(self, document: nodes.document, maxchars: int = 200): (source)
Parameters
document:nodes.documentThe docutils document to extract a summary from.
maxchars:intMaximum of characters the summary can span. Sentences are not cut in the middle, so the actual length might be longer if your have a large first paragraph.
def unknown_visit(self, node: nodes.Node): (source)

Ignore all unknown nodes

def visit_document(self, node: nodes.Node): (source)

Undocumented

def visit_field(self, node: nodes.Node): (source)

Undocumented

def visit_paragraph(self, node: nodes.paragraph): (source)

Undocumented

maxchars = (source)

Undocumented

other_docs: bool = (source)

Undocumented

summary: ParsedDocstring | None = (source)

Undocumented

_SENTENCE_RE_SPLIT = (source)

Undocumented

Value
re.compile(r'( *[\.\?!][\'"\)\]]* *)')