epydoc.markup.epytext.ParsedEpytextDocstring

Package epydoc :: Package markup :: Module epytext :: Class ParsedEpytextDocstring

Class ParsedEpytextDocstring
source code

Instance Methods	[hide private]

__init__(self, dom_tree)

string to_html(self, docstring_linker, directory=None, docindex=None, context=None, **options)
Translate this docstring to HTML.

string to_latex(self, docstring_linker, **options)
Translate this docstring to LaTeX.

string to_plaintext(self, docstring_linker, **options)
Translate this docstring to plaintext.

_index_term_key(self, tree)

_to_html(self, tree, linker, directory, docindex, context, indent=0, seclevel=0)

_build_graph(self, graph_type, graph_args, linker, docindex, context)

_to_latex(self, tree, linker, indent=0, seclevel=0, breakany=0)

ParsedDocstring summary(self)

(ParsedDocstring, list of Field) split_fields(self, errors=None)
Split this docstring into its body and its fields.

list of ParsedDocstring index_terms(self)

_index_terms(self, tree, terms)

Inherited from ParsedDocstring: __add__, concatenate

Class Variables	[hide private]

SYMBOL_TO_HTML

SYMBOL_TO_LATEX

Method Details	[hide private]

init(self, dom_tree)
(Constructor)

source code
call graph

to_html(self, docstring_linker, directory=None, docindex=None, context=None, **options)

source code
call graph

Translate this docstring to HTML.

Returns: string: An HTML fragment that encodes this docstring.

Overrides: ParsedDocstring.to_html: (inherited documentation)

to_latex(self, docstring_linker, **options)

source code

Translate this docstring to LaTeX.

Returns: string: A LaTeX fragment that encodes this docstring.

Overrides: ParsedDocstring.to_latex: (inherited documentation)

to_plaintext(self, docstring_linker, **options)

source code
call graph

Translate this docstring to plaintext.

Returns: string: A plaintext fragment that encodes this docstring.

Overrides: ParsedDocstring.to_plaintext: (inherited documentation)

_index_term_key(self, tree)

source code

_to_html(self, tree, linker, directory, docindex, context, indent=0, seclevel=0)

source code
call graph

_build_graph(self, graph_type, graph_args, linker, docindex, context)

source code
call graph

_to_latex(self, tree, linker, indent=0, seclevel=0, breakany=0)

source code

summary(self)

source code
call graph

Returns: ParsedDocstring: A short summary of this docstring. Typically, the summary consists of the first sentence of the docstring.

Overrides: ParsedDocstring.summary: (inherited documentation)

split_fields(self, errors=None)

source code
call graph

Split this docstring into its body and its fields.

Returns: (ParsedDocstring, list of Field): A tuple (body, fields), where body is the main body of this docstring, and fields is a list of its fields.

Overrides: ParsedDocstring.split_fields: (inherited documentation)

index_terms(self)

source code
call graph

Returns: list of ParsedDocstring: The list of index terms that are defined in this docstring. Each of these items will be added to the index page of the documentation.

Overrides: ParsedDocstring.index_terms: (inherited documentation)

_index_terms(self, tree, terms)

source code
call graph

Class Variable Details	[hide private]

SYMBOL_TO_HTML

Value:

{'Chi': 'Chi',
 'Epsilon': 'Epsilon',
 'Eta': 'Eta',
 'Psi': 'Psi',
 'asymp': 'asymp',
 'cup': 'cup',
 'equiv': 'equiv',
 'ge': 'ge',
...

SYMBOL_TO_LATEX

Value:

{'Chi': '\\(\\chi\\)',
 'Epsilon': '\\(\\epsilon\\)',
 'Eta': '\\(\\eta\\)',
 'Psi': '\\(\\Psi\\)',
 'asymp': '\\(\\approx\\)',
 'cup': '\\(\\cup\\)',
 'equiv': '\\(\\equiv\\)',
 'ge': '\\(\\ge\\)',
...

Class ParsedEpytextDocstring source code

__init__(self, dom_tree) (Constructor)

to_html(self, docstring_linker, directory=None, docindex=None, context=None, **options)

to_latex(self, docstring_linker, **options)

to_plaintext(self, docstring_linker, **options)

_index_term_key(self, tree)

_to_html(self, tree, linker, directory, docindex, context, indent=0, seclevel=0)

_build_graph(self, graph_type, graph_args, linker, docindex, context)

_to_latex(self, tree, linker, indent=0, seclevel=0, breakany=0)

summary(self)

split_fields(self, errors=None)

index_terms(self)

_index_terms(self, tree, terms)

SYMBOL_TO_HTML

SYMBOL_TO_LATEX

Class ParsedEpytextDocstring
source code

init(self, dom_tree)
(Constructor)