benchmarkstt.docblock module¶

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

Bases: tuple

docs¶: Alias for field number 0

params¶: Alias for field number 1

result¶: Alias for field number 2

result_type¶: Alias for field number 3

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

Bases: tuple

name¶: Alias for field number 0

type¶: Alias for field number 1

value¶: Alias for field number 2

class benchmarkstt.docblock.HTML5Writer[source]¶

Bases: docutils.writers.html5_polyglot.Writer

apply_template()[source]¶

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

Bases: tuple

description¶: Alias for field number 4

examples¶: Alias for field number 5

is_required¶: Alias for field number 3

name¶: Alias for field number 0

type¶: Alias for field number 1

type_doc¶: Alias for field number 2

class benchmarkstt.docblock.TextWriter[source]¶

Bases: docutils.writers.Writer

class TextVisitor(document)[source]¶

Bases: docutils.nodes.SparseNodeVisitor

text()[source]¶

visit_Text(node)[source]¶

visit_paragraph(node)[source]¶

translate()[source]¶

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)[source]¶

benchmarkstt.docblock.doc_param_parser(docstring, key, no_name=None, allow_multiple=None, replace_strat=None)[source]¶

benchmarkstt.docblock.format_docs(docs)[source]¶

benchmarkstt.docblock.parse(func)[source]¶

benchmarkstt.docblock.process_rst(text, writer=None)[source]¶