pydoctor.test.epydoc.test_restructuredtext

module documentation

(source)

Undocumented

Function	`node2html`	Undocumented
Function	`parse_rst`	Undocumented
Function	`prettify`	Undocumented
Function	`rst2html`	Render a docstring to HTML.
Function	`rst2node`	Undocumented
Function	`test_get_toc`	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
Function	`test_summary`	Summaries are generated from the inline text inside the first paragraph. The text is trimmed as soon as we reach a break point (or another docutils element) after 200 characters.

def node2html(node, oneline=True): (source) ¶

Undocumented

Parameters
node:`nodes.Node`	Undocumented
oneline:`bool`	Undocumented
Returns
`str`	Undocumented

def parse_rst(s): (source) ¶

Undocumented

Parameters
s:`str`	Undocumented
Returns
`ParsedDocstring`	Undocumented

def prettify(html): (source) ¶

Undocumented

Parameters
html:`str`	Undocumented
Returns
`str`	Undocumented

def rst2html(docstring, linker=NotFoundLinker()): (source) ¶

Render a docstring to HTML.

Parameters
docstring:`str`	Undocumented
linker:`DocstringLinker`	Undocumented
Returns
`str`	Undocumented

def rst2node(s): (source) ¶

Undocumented

Parameters
s:`str`	Undocumented
Returns
`nodes.document`	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_rst_anon_link_email(): (source) ¶

Undocumented

def test_rst_anon_link_target_missing(): (source) ¶

Undocumented

def test_rst_body_empty(): (source) ¶

Undocumented

def test_rst_body_nonempty(): (source) ¶

Undocumented

def test_rst_directive_adnomitions(): (source) ¶

Undocumented

def test_rst_directive_deprecated(): (source) ¶

It renders the deprecated RST directive with custom markup and supports an extra text besides the version information.

def test_rst_directive_seealso(): (source) ¶

Undocumented

def test_rst_directive_versionadded(): (source) ¶

It renders the versionadded RST directive using a custom markup with dedicated CSS classes.

def test_rst_directive_versionchanged(): (source) ¶

It renders the versionchanged RST directive with custom markup and supports an extra text besides the version information.

def test_rst_partial(): (source) ¶

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(): (source) ¶

Undocumented

def test_rst_xref_with_target(): (source) ¶

Undocumented

@pytest.mark.parametrize('markup', ('epytext', 'plaintext', 'restructuredtext', 'numpy', 'google'))
def test_summary(markup): (source) ¶

Summaries are generated from the inline text inside the first paragraph. The text is trimmed as soon as we reach a break point (or another docutils element) after 200 characters.

Parameters
markup:`str`	Undocumented