Package epydoc :: Package markup :: Module restructuredtext :: Class _SummaryExtractor

[hide private]
[frames] | no frames]

# Class _SummaryExtractor

source code

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

Instance Methods | [hide private]

__init__(self, document) | source code call graph

Call Graph

visit_document(self, node) | source code call graph

Call Graph

visit_paragraph(self, node) | source code call graph

Call Graph

visit_field(self, node) | source code

unknown_visit(self, node) Ignore all unknown nodes | source code call graph

Call Graph

Inherited from `docutils.nodes.NodeVisitor`: `dispatch_departure`, `dispatch_visit`, `unknown_departure`

Class Variables | [hide private]

| _SUMMARY_RE = `re.compile(r'`(`\s`*``[`\w\W`]``*?`\.`)``(`\s`|`$`)`')`
Inherited from `docutils.nodes.NodeVisitor`: `optional`

Method Details | [hide private]

### __init__(self, document)
(Constructor)

source code
call graph

Call Graph

Overrides: docutils.nodes.NodeVisitor.__init__

### unknown_visit(self, node)

source code
call graph

Call Graph

Ignore all unknown nodes

Overrides: docutils.nodes.NodeVisitor.unknown_visit