epydoc.markup.restructuredtext._TermsExtractor

Package epydoc :: Package markup :: Module restructuredtext :: Class _TermsExtractor |
[hide private]
[frames] | no frames]

# Class _TermsExtractor

source code

A docutils node visitor that extracts the terms from documentation.

Terms are created using the `:term:` interpreted text role.

Instance Methods | [hide private]
__init__(self, document) | source code call graph
Call Graph
visit_document(self, node) | source code call graph
Call Graph
visit_emphasis(self, node) | source code call graph
Call Graph
depart_emphasis(self, node) | source code call graph
Call Graph
visit_Text(self, node) | source code call graph
Call Graph
unknown_visit(self, node) Ignore all unknown nodes | source code call graph
Call Graph
unknown_departure(self, node) Ignore all unknown nodes | source code call graph
Call Graph
Inherited from `docutils.nodes.NodeVisitor`: `dispatch_departure`, `dispatch_visit`

Class Variables | [hide private]
Inherited from `docutils.nodes.NodeVisitor`: `optional`

Instance Variables | [hide private]
`list` | terms The terms currently found.

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

### unknown_departure(self, node) | source code call graph
Call Graph
Ignore all unknown nodes Overrides: docutils.nodes.NodeVisitor.unknown_departure