{ "info": { "author": "Bystroushaak", "author_email": "bystrousak@kitakitsune.org", "bugtrack_url": null, "classifiers": [ "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7" ], "description": "napoleon2html\n===============================\n\n.. image:: https://badge.fury.io/py/napoleon2html.png\n :target: http://badge.fury.io/py/napoleon2html\n\n.. image:: https://pypip.in/d/napoleon2html/badge.png\n :target: https://pypi.python.org/pypi/napoleon2html\n\n\nThis project contains functions that encapsulate tranlation of Sphinx or\n`Napoleon `_ docstrings to HTML.\n\nDocumentation\n-------------\n\nThere are three function, that can be used: ``napoleon_to_sphinx()``, ``sphinx_to_html()`` and ``napoleon_to_html()``.\n\nnapoleon_to_sphinx()\n++++++++++++++++++++\n\nThis function can take documentation in `Napoleon `_ format and translate it to Sphinx. \n\nUsage::\n\n napoleon2html.napoleon_to_sphinx(\"\"\"\n Description of function\n \n Args:\n argument (str): Description of argument.\n \n Returns:\n int: Description of return.\n \"\"\")\n \n\nOutput::\n\n Description of function\n \n :Parameters: **argument** (*str*) --\n Description of argument.\n \n :returns: *int* --\n Description of return.\n\n\nsphinx_to_html()\n++++++++++++++++\nThen there is the ``sphinx_to_html()``, which converts string in Sphinx format to HTML::\n\n napoleon2html.sphinx_to_html(\"\"\"\n Description of function\n \n :Parameters: **argument** (*str*) --\n Description of argument.\n \n :returns: *int* --\n Description of return.\n \"\"\")\n\nOutput::\n\n
\n

Description of function

\n \n \n \n \n \n \n \n \n \n
Parameters:argument (str) --\n Description of argument.
returns:int --\n Description of return.
\n
\n\nnapoleon_to_html()\n++++++++++++++++++\nLast function is ``napoleon_to_html()``, which wraps the previous two.\n\nChangelog\n=========\n\n0.2.0\n-----\n - Fixed bug in MANIFEST.in.\n\n0.1.0\n-----\n - Project created.", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/Bystroushaak/napoleon2html", "keywords": null, "license": "MIT", "maintainer": null, "maintainer_email": null, "name": "napoleon2html", "package_url": "https://pypi.org/project/napoleon2html/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/napoleon2html/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/Bystroushaak/napoleon2html" }, "release_url": "https://pypi.org/project/napoleon2html/0.2.0/", "requires_dist": null, "requires_python": null, "summary": "Wrappers to translate Napoleon/Sphinx docstrings to HTML.", "version": "0.2.0" }, "last_serial": 1369376, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "0f46cd1c22a0f3881aecf35d2a789190", "sha256": "a7f7f9f03141c9b41da89b9bdf133931dda7118d2acef9164d497c40baa27dfd" }, "downloads": -1, "filename": "napoleon2html-0.1.0.tar.gz", "has_sig": false, "md5_digest": "0f46cd1c22a0f3881aecf35d2a789190", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3653, "upload_time": "2015-01-03T18:17:13", "url": "https://files.pythonhosted.org/packages/81/ea/438bc3a146b0294ff222397de4d3c292792ca7487a3564a5df0f1bdf115d/napoleon2html-0.1.0.tar.gz" } ], "0.2.0": [ { "comment_text": "", "digests": { "md5": "ca1bc26bd4b79447370e43f4bbf3559c", "sha256": "3e55049de7fe5302fe3c853be72e0a87b9ed0ba2993d8dbdf7a08a52f83c0d2f" }, "downloads": -1, "filename": "napoleon2html-0.2.0.tar.gz", "has_sig": false, "md5_digest": "ca1bc26bd4b79447370e43f4bbf3559c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3718, "upload_time": "2015-01-03T18:21:07", "url": "https://files.pythonhosted.org/packages/c9/5f/0c3c85456d1615a606fef7ac5e8637c90710ba589e1a34833c9471b33427/napoleon2html-0.2.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "ca1bc26bd4b79447370e43f4bbf3559c", "sha256": "3e55049de7fe5302fe3c853be72e0a87b9ed0ba2993d8dbdf7a08a52f83c0d2f" }, "downloads": -1, "filename": "napoleon2html-0.2.0.tar.gz", "has_sig": false, "md5_digest": "ca1bc26bd4b79447370e43f4bbf3559c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3718, "upload_time": "2015-01-03T18:21:07", "url": "https://files.pythonhosted.org/packages/c9/5f/0c3c85456d1615a606fef7ac5e8637c90710ba589e1a34833c9471b33427/napoleon2html-0.2.0.tar.gz" } ] }