module documentation

Undocumented

Function node2html Undocumented
Function parse​_rst Undocumented
Function prettify Undocumented
Function rst2html Render a docstring to HTML.
Function rst2node Undocumented
Function test​_rst​_anon​_link​_email Undocumented
Function test​_rst​_anon​_link​_target​_missing Undocumented
Function test​_rst​_body​_empty Undocumented
Function test​_rst​_body​_nonempty Undocumented
Function test​_rst​_directive​_adnomitions Undocumented
Function test​_rst​_directive​_deprecated It renders the deprecated RST directive with custom markup and supports an extra text besides the version information.
Function test​_rst​_directive​_seealso Undocumented
Function test​_rst​_directive​_versionadded It renders the versionadded RST directive using a custom markup with dedicated CSS classes.
Function test​_rst​_directive​_versionchanged It renders the versionchanged RST directive with custom markup and supports an extra text besides the version information.
Function test​_rst​_partial The node2html() function can convert fragment of a docutils document, it's not restricted to actual docutils.nodes.document object.
Function test​_rst​_xref​_implicit​_target Undocumented
Function test​_rst​_xref​_with​_target Undocumented
def node2html(node, oneline=True):

Undocumented

Parameters
node:nodes.NodeUndocumented
oneline:boolUndocumented
Returns
strUndocumented
def parse_rst(s):

Undocumented

Parameters
s:strUndocumented
Returns
ParsedDocstringUndocumented
def prettify(html):

Undocumented

Parameters
html:strUndocumented
Returns
strUndocumented
def rst2html(docstring, linker=NotFoundLinker()):
Render a docstring to HTML.
Parameters
docstring:strUndocumented
linker:DocstringLinkerUndocumented
Returns
strUndocumented
def rst2node(s):

Undocumented

Parameters
s:strUndocumented
Returns
nodes.documentUndocumented
def test_rst_anon_link_email():

Undocumented

def test_rst_anon_link_target_missing():

Undocumented

def test_rst_body_empty():

Undocumented

def test_rst_body_nonempty():

Undocumented

def test_rst_directive_adnomitions():

Undocumented

def test_rst_directive_deprecated():
It renders the deprecated RST directive with custom markup and supports an extra text besides the version information.
def test_rst_directive_seealso():

Undocumented

def test_rst_directive_versionadded():
It renders the versionadded RST directive using a custom markup with dedicated CSS classes.
def test_rst_directive_versionchanged():
It renders the versionchanged RST directive with custom markup and supports an extra text besides the version information.
def test_rst_partial():

The node2html() function can convert fragment of a docutils document, it's not restricted to actual docutils.nodes.document object.

Really, any nodes can be passed to that function, the only requirement is that the node's document attribute is set to a valid docutils.nodes.document object.

def test_rst_xref_implicit_target():

Undocumented

def test_rst_xref_with_target():

Undocumented