Python docstring_to_rest Examples

Example #1

File: test_docstrings.py Project: bossjones/pgi-docgen

 def _check(self, text, expected, current_type=None, current_func=None):
     out = docstring_to_rest(self._repo, text, current_type, current_func)
     self.assertEqual(out, expected)

Example #2

 def _check(self, text, expected, current_type=None, current_func=None):
     out = docstring_to_rest(self._repo, text, current_type, current_func)
     self.assertEqual(out, expected)

Example #3

 def _check(self, text, expected):
     out = docstring_to_rest(self.types, "Gtk.Widget", text)
     self.assertEqual(out, expected)

Example #4

File: test_markdown.py Project: tobias47n9e/pgi-docgen

    def test_basic(self):
        md_example = u"""\
identifier:

documentation ...

# Height-for-width Geometry Management # {#geometry-management}

# A level-one header with a [link](/url) and *emphasis*

## adsad ##

### afaf ###

Here is some `inline code`

Documentation:

- list item 1
- list item 2 [link](/url) foo

Even more docs.\
"""

        expected = """\
<para>identifier:</para>
<para>documentation ...</para>
<title>Height-for-width Geometry Management</title>
<title>A level-one header with a <ulink url="/url">link</ulink> and <emphasis>emphasis</emphasis></title>
<subtitle>adsad</subtitle>
<subtitle>afaf</subtitle>
<para>Here is some <literal>inline code</literal></para>
<para>Documentation:</para>
<itemizedlist>
<listitem>list item 1</listitem>
<listitem>list item 2 <ulink url="/url">link</ulink> foo</listitem>
</itemizedlist>
<para>Even more docs.</para>\
"""

        rst_expected = """\
identifier\:
documentation ...
Height-for-width Geometry Management
A level-one header with alinkandemphasis
adsad
afaf
Here is some ``inline code``
Documentation\:


* list item 1
* list item 2 `link </url>`__ foo


Even more docs.\
"""

        docbook = markdown2docbook(md_example)
        self.assertEqual(docbook, expected, msg=docbook)
        rest = docstring_to_rest({}, "Foo.Bar", docbook)
        self.assertEqual(rest, rst_expected, msg=rest)

Example #5

File: test_docstrings.py Project: ManuelGotzen/pgi-docgen

 def _check(self, text, expected):
     out = docstring_to_rest(self.types, "Gtk.Widget", text)
     self.assertEqual(out, expected)