Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Wrappers to translate Napoleon/Sphinx docstrings to HTML.

Project Description

napoleon2html

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.
Release History

Release History

This version
History Node

0.2.0

History Node

0.1.0

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
napoleon2html-0.2.0.tar.gz (3.7 kB) Copy SHA256 Checksum SHA256 Source Jan 3, 2015

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting