Skip to main content

Wrappers to translate Napoleon/Sphinx docstrings to HTML.

Project description

napoleon2html

https://badge.fury.io/py/napoleon2html.png https://pypip.in/d/napoleon2html/badge.png

This project contains functions that encapsulate tranlation of Sphinx or Napoleon docstrings to HTML.

Documentation

There are three function, that can be used: napoleon_to_sphinx(), sphinx_to_html() and napoleon_to_html().

napoleon_to_sphinx()

This function can take documentation in Napoleon format and translate it to Sphinx.

Usage:

napoleon2html.napoleon_to_sphinx("""
    Description of function

    Args:
        argument (str): Description of argument.

    Returns:
        int: Description of return.
""")

Output:

Description of function

:Parameters: **argument** (*str*) --
             Description of argument.

:returns: *int* --
          Description of return.

sphinx_to_html()

Then there is the sphinx_to_html(), which converts string in Sphinx format to HTML:

napoleon2html.sphinx_to_html("""
    Description of function

    :Parameters: **argument** (*str*) --
                 Description of argument.

    :returns: *int* --
              Description of return.
""")

Output:

<blockquote>
<p>Description of function</p>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>argument</strong> (<em>str</em>) --
Description of argument.</td>
</tr>
<tr class="field"><th class="field-name">returns:</th><td class="field-body"><em>int</em> --
Description of return.</td>
</tr>
</tbody>
</table>
</blockquote>

napoleon_to_html()

Last function is napoleon_to_html(), which wraps the previous two.

Changelog

0.2.0

  • Fixed bug in MANIFEST.in.

0.1.0

  • Project created.

Project details


Release history Release notifications

This version
History Node

0.2.0

History Node

0.1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
napoleon2html-0.2.0.tar.gz (3.7 kB) Copy SHA256 hash SHA256 Source None Jan 3, 2015

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page