module documentation

Test how epytext is transformed to HTML using ParsedDocstring.to_node() and node2stan.node2stan() functions.

Many of these test cases are adapted examples from the epytext documentation.

Function epytext2html Undocumented
Function epytext2node Undocumented
Function parse_epytext Undocumented
Function squash Undocumented
Function test_epytext_complex_list Undocumented
Function test_epytext_inline Undocumented
Function test_epytext_literal_block Undocumented
Function test_epytext_nested_list Undocumented
Function test_epytext_ordered_list Undocumented
Function test_epytext_paragraph Undocumented
Function test_epytext_sections Undocumented
Function test_epytext_symbol Undocumented
Function test_epytext_url Undocumented
Function test_get_toc Undocumented
Function test_nested_markup The Epytext nested inline markup are correctly transformed to HTML.
def epytext2html(s): (source)

Undocumented

Parameters
s:strUndocumented
Returns
strUndocumented
def epytext2node(s): (source)

Undocumented

Parameters
s:strUndocumented
Returns
nodes.documentUndocumented
def parse_epytext(s): (source)

Undocumented

Parameters
s:strUndocumented
Returns
ParsedDocstringUndocumented
def squash(s): (source)

Undocumented

Parameters
s:strUndocumented
Returns
strUndocumented
def test_epytext_complex_list(): (source)

Undocumented

def test_epytext_inline(): (source)

Undocumented

def test_epytext_literal_block(): (source)

Undocumented

def test_epytext_nested_list(): (source)

Undocumented

def test_epytext_ordered_list(): (source)

Undocumented

def test_epytext_paragraph(): (source)

Undocumented

def test_epytext_sections(): (source)

Undocumented

def test_epytext_symbol(): (source)

Undocumented

def test_epytext_url(): (source)

Undocumented

@pytest.mark.skipif((docutils_version_info < (0, 18)), reason='HTML ids in toc tree changed in docutils 0.18.0.')
def test_get_toc(): (source)

Undocumented

def test_nested_markup(): (source)

The Epytext nested inline markup are correctly transformed to HTML.