{ "info": { "author": "PentairIoT", "author_email": "pentairiot@gmail.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "# pydocless\n\nLibrary for turning your python docstrings into Markdown documentation.\nNote this should not be used as a substitute for good documentation, but as an addition.\nThe style is intended to look similar to Python's standard library API docs.\n\n### Usage:\nFrom the command line:\n```\npydocless config.json > module_doc.md\n```\n\nOr from within a python environment:\n```\nfrom pydocless import pydocless\nmd_text = pydocless(config)\n```\n\nThe config object should be a dictionary:\n```\n{\n \"module\": \"module_name\", # Module should be available within the python environment\n \"includes\": [], # List of regexes for what to include. By default nothing is included\n \"excludes\": [] # List of regexes for what to exclude. By default everything is excluded\n}\n```\n\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/pentairiot/pydocless", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "pydocless", "package_url": "https://pypi.org/project/pydocless/", "platform": "", "project_url": "https://pypi.org/project/pydocless/", "project_urls": { "Homepage": "https://github.com/pentairiot/pydocless" }, "release_url": "https://pypi.org/project/pydocless/0.0.2/", "requires_dist": null, "requires_python": "", "summary": "Python library for creating markdown documentation from python docstrings", "version": "0.0.2" }, "last_serial": 4530681, "releases": { "0.0.2": [ { "comment_text": "", "digests": { "md5": "e4fa6268e9b0d081755f252e9e707bf4", "sha256": "941d59d15fae7b5e9190045565db34baa2f9a65e7648c00aaa5b606929d79b15" }, "downloads": -1, "filename": "pydocless-0.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "e4fa6268e9b0d081755f252e9e707bf4", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 3426, "upload_time": "2018-11-26T18:37:02", "url": "https://files.pythonhosted.org/packages/ed/e4/46b5fe7527781f1b69c41db39e77090c656bd694466d6abbb8d4066801f3/pydocless-0.0.2-py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "e4fa6268e9b0d081755f252e9e707bf4", "sha256": "941d59d15fae7b5e9190045565db34baa2f9a65e7648c00aaa5b606929d79b15" }, "downloads": -1, "filename": "pydocless-0.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "e4fa6268e9b0d081755f252e9e707bf4", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 3426, "upload_time": "2018-11-26T18:37:02", "url": "https://files.pythonhosted.org/packages/ed/e4/46b5fe7527781f1b69c41db39e77090c656bd694466d6abbb8d4066801f3/pydocless-0.0.2-py3-none-any.whl" } ] }