{ "info": { "author": "Thomas Gl\u00e4\u00dfle", "author_email": "t_glaessle@gmx.de", "bugtrack_url": null, "classifiers": [ "Development Status :: 3 - Alpha", "Intended Audience :: Developers", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Software Development" ], "description": "doc2md\n------\n\nVery lightweight docstring to Markdown converter.\n\nLicense\n~~~~~~~\n\nCopyright \u00a9 2013 Thomas Gl\u00e4\u00dfle t_glaessle@gmx.de\n\nThis work is free. You can redistribute it and/or modify it under the\nterms of the Do What The Fuck You Want To Public License, Version 2, as\npublished by Sam Hocevar. See the COPYING file for more details.\n\nThis program is free software. It comes without any warranty, to the\nextent permitted by applicable law.\n\nDescription\n~~~~~~~~~~~\n\nLittle convenience tool to extract docstrings from a module or class and\nconvert them to GitHub Flavoured Markdown:\n\nhttps://help.github.com/articles/github-flavored-markdown\n\nIts purpose is to quickly generate ``README.md`` files for small\nprojects.\n\nAPI\n~~~\n\nThe interface consists of the following functions:\n\n- ``doctrim(docstring)``\n- ``doc2md(docstring, title)``\n\nYou can run this script from the command line like:\n\n.. code:: bash\n\n $ doc2md.py [-a] [--no-toc] [-t title] module-name [class-name] > README.md\n\nLimitations\n~~~~~~~~~~~\n\nAt the moment this is suited only for a very specific use case. It is\nhardly forseeable, if I will decide to improve on it in the near future.", "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/coldfix/doc2md", "keywords": null, "license": "WTFPL", "maintainer": null, "maintainer_email": null, "name": "doc2md", "package_url": "https://pypi.org/project/doc2md/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/doc2md/", "project_urls": { "Download": "UNKNOWN", "Homepage": "https://github.com/coldfix/doc2md" }, "release_url": "https://pypi.org/project/doc2md/0.1.0/", "requires_dist": null, "requires_python": null, "summary": "Lightweight docstring to markdown converter", "version": "0.1.0" }, "last_serial": 866484, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "1fabff4ebe5e45dd8997e96b3c650e51", "sha256": "22b76a53256077dcbac539731f806f90439a0bd564bd4879513968cbe97bb6d8" }, "downloads": -1, "filename": "doc2md-0.1.0.tar.gz", "has_sig": false, "md5_digest": "1fabff4ebe5e45dd8997e96b3c650e51", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4593, "upload_time": "2013-09-16T04:36:34", "url": "https://files.pythonhosted.org/packages/4b/91/36c863845e9b4afb537ca1f5be75b2751c367e35df59e0ad1a9a33d3ea2e/doc2md-0.1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "1fabff4ebe5e45dd8997e96b3c650e51", "sha256": "22b76a53256077dcbac539731f806f90439a0bd564bd4879513968cbe97bb6d8" }, "downloads": -1, "filename": "doc2md-0.1.0.tar.gz", "has_sig": false, "md5_digest": "1fabff4ebe5e45dd8997e96b3c650e51", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4593, "upload_time": "2013-09-16T04:36:34", "url": "https://files.pythonhosted.org/packages/4b/91/36c863845e9b4afb537ca1f5be75b2751c367e35df59e0ad1a9a33d3ea2e/doc2md-0.1.0.tar.gz" } ] }