benchmarkstt.docblock module

%%{init: {'theme': 'base', 'themeVariables': { 'primaryColor': '#e7f2fa', 'lineColor': '#2980B9' }}}%% classDiagram HTML5Writer TextWriter Writer <|-- HTML5Writer Writer <|-- TextWriter class Docblock { <<namedtuple>> docs params result result_type } class Param { <<namedtuple>> name type type_doc is_required description examples } class DocblockParam { <<namedtuple>> name type value } class HTML5Writer { +apply_template() +assemble_parts() +get_transforms() +interpolation_dict() +supports(format) +translate() +write(document, destination) } class TextWriter { +assemble_parts() +get_transforms() +supports(format) +translate() +write(document, destination) }

class benchmarkstt.docblock.Docblock(docs, params, result, result_type)

Bases: tuple

property docs

Alias for field number 0

property params

Alias for field number 1

property result

Alias for field number 2

property result_type

Alias for field number 3

class benchmarkstt.docblock.DocblockParam(name, type, value)

Bases: tuple

property name

Alias for field number 0

property type

Alias for field number 1

property value

Alias for field number 2

class benchmarkstt.docblock.HTML5Writer

Bases: docutils.writers.html5_polyglot.Writer

apply_template()

class benchmarkstt.docblock.Param(name, type, type_doc, is_required, description, examples)

Bases: tuple

property description

Alias for field number 4

property examples

Alias for field number 5

property is_required

Alias for field number 3

property name

Alias for field number 0

property type

Alias for field number 1

property type_doc

Alias for field number 2

class benchmarkstt.docblock.TextWriter

Bases: docutils.writers.Writer

class TextVisitor(document)

Bases: docutils.nodes.SparseNodeVisitor

text()

visit_Text(node)

visit_paragraph(node)

translate()

Do final translation of self.document into self.output. Called from write. Override in subclasses.

Usually done with a docutils.nodes.NodeVisitor subclass, in combination with a call to docutils.nodes.Node.walk() or docutils.nodes.Node.walkabout(). The NodeVisitor subclass must support all standard elements (listed in docutils.nodes.node_class_names) and possibly non-standard elements used by the current Reader as well.

benchmarkstt.docblock.decode_literal(txt: str)

benchmarkstt.docblock.doc_param_parser(docstring, key, no_name=None, allow_multiple=None, replace_strat=None)

benchmarkstt.docblock.format_docs(docs)

benchmarkstt.docblock.parse(func)

benchmarkstt.docblock.process_rst(text, writer=None)