{ "info": { "author": "Chris Pyles", "author_email": "cpyles@berkeley.edu", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python :: 3" ], "description": "# docpy\n\nThis package auto-generates Markdown documentation from Python files.\n\n## Installation\n\nThis package is installed using pip:\n\n```\npip install docpy\n```\n\n## Usage\n\nThis package is used from the command line:\n\n```\ndocpy ...\n```\n\nThe package help entry is given below.\n\n```\nusage: docpy [-h] [-a APPEND] [-o OUT] [-s SUB] [-t TEMP] ...\n\ngenerate Markdown documentation for Python files\n\npositional arguments:\n files files to be documented\n\noptional arguments:\n -h, --help show this help message and exit\n -a APPEND, --append APPEND\n file to which to append generated Markdown\n -o OUT, --output OUT file to save generated Markdown to\n -s SUB, --sub SUB file with ::DOCUMENTATION:: tag to replace Markdown\n -t TEMP, --template TEMP\n template file with ::DOCUMENTATION:: tag, needs OUT\n argument\n```\n\n### Templates\n\nYou can define a Markdown template in which your documentation will be placed using the `-t` flag, which must be used in conjunction with the `-o` flag. In your template, just put `::DOCUMENTATION::` where you want the documentation to be placed. For example,\n\n```markdown\n# This is a markdown file.\n\nMy docs are below:\n\n::DOCUMENTATION::\n\n_this concludes the documentation._\n```\n\n## Changelog\n\n**v0.1.1:**\n\n* Fixed formatting error in docstrings\n\n**v0.1.0:**\n\n* Initial release\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/chrispyles/docpy", "keywords": "", "license": "BSD-3-Clause", "maintainer": "", "maintainer_email": "", "name": "docpy", "package_url": "https://pypi.org/project/docpy/", "platform": "", "project_url": "https://pypi.org/project/docpy/", "project_urls": { "Homepage": "https://github.com/chrispyles/docpy" }, "release_url": "https://pypi.org/project/docpy/0.1.1/", "requires_dist": null, "requires_python": "", "summary": "Python to MD documentation generator", "version": "0.1.1" }, "last_serial": 5716644, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "14c7bc9c20b88f44f59a25699f82cb0b", "sha256": "d5d5672cbe32537a207603e98e625570029ad6138d22ddf39502054e306b9f5d" }, "downloads": -1, "filename": "docpy-0.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "14c7bc9c20b88f44f59a25699f82cb0b", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4879, "upload_time": "2019-08-22T18:23:32", "url": "https://files.pythonhosted.org/packages/e3/55/71728e82034ad2fd45c2985ac274713eab8299628bdf6ffc91dd053342ef/docpy-0.0.1-py3-none-any.whl" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "1d43f466883caba6f0f7fc5585a664ea", "sha256": "c24701841c228e6cf5597aa52ffd15b7dfcff0d2acb8989b649bf0367017facf" }, "downloads": -1, "filename": "docpy-0.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "1d43f466883caba6f0f7fc5585a664ea", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4881, "upload_time": "2019-08-22T18:23:34", "url": "https://files.pythonhosted.org/packages/82/e7/409c11d0c2a431e02294d0eff747d87135e52e68fb6e6b593ccd787fff94/docpy-0.0.2-py3-none-any.whl" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "c936dd2aa0d4a377b0bd9f602c887670", "sha256": "05172b12a1a7ae1f04ebb3cde9c6b0a6b66fc4c1e8ecae8a524ed58fa7267086" }, "downloads": -1, "filename": "docpy-0.0.3-py3-none-any.whl", "has_sig": false, "md5_digest": "c936dd2aa0d4a377b0bd9f602c887670", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4855, "upload_time": "2019-08-22T18:23:36", "url": "https://files.pythonhosted.org/packages/2a/21/2f23b57b8e11c68bf1199e4411b8e6ad6faa4f3e0b68c8d0e42080643e9b/docpy-0.0.3-py3-none-any.whl" } ], "0.1.0": [ { "comment_text": "", "digests": { "md5": "7cb87daf7190d7f180c45ae7dc87afbc", "sha256": "628f666a63419132137f5a2c0b548d121fa179e4b446ca69663cc29af2a771b0" }, "downloads": -1, "filename": "docpy-0.1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "7cb87daf7190d7f180c45ae7dc87afbc", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4902, "upload_time": "2019-08-22T18:23:55", "url": "https://files.pythonhosted.org/packages/31/bf/c8427a904c17318ba51ebb109e0cfde5d243cc65bda9131e25dc8bddf57a/docpy-0.1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "7aa3d5b4f9a49b6225fd2223d1a86591", "sha256": "76c5ab966a70b0e7badd5c96fe6ac9ab7ec682b4005a1a605157e7972bd2d365" }, "downloads": -1, "filename": "docpy-0.1.0.tar.gz", "has_sig": false, "md5_digest": "7aa3d5b4f9a49b6225fd2223d1a86591", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3322, "upload_time": "2019-08-22T18:23:57", "url": "https://files.pythonhosted.org/packages/6b/da/fda94fc453b045ac5cf2d5977b8402e8425e4d1d34c3f32be71099117ede/docpy-0.1.0.tar.gz" } ], "0.1.1": [ { "comment_text": "", "digests": { "md5": "a6f32185529b1296deb027f0896e6ed5", "sha256": "d8033bbc9e98169a00efb36aac2633dd9e78d15bddaa76c0f8e51ebe443db943" }, "downloads": -1, "filename": "docpy-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "a6f32185529b1296deb027f0896e6ed5", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5097, "upload_time": "2019-08-22T18:31:58", "url": "https://files.pythonhosted.org/packages/38/dc/ff1299b59b5ad0cecc6f4a81c0c316a0111215fdcc2e3e6671396076d8aa/docpy-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b82aca0e5e67060b32cdd105aaf300a3", "sha256": "c51adab89d33859c62f2fc1f1ccccfc7eb79d6f67a22c574d6d1f975d34b5136" }, "downloads": -1, "filename": "docpy-0.1.1.tar.gz", "has_sig": false, "md5_digest": "b82aca0e5e67060b32cdd105aaf300a3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3568, "upload_time": "2019-08-22T18:32:00", "url": "https://files.pythonhosted.org/packages/bc/82/bec5e8c480dc40ff8a3bbbe8e9653b16e0cf7b5fb1b632db84c175279473/docpy-0.1.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "a6f32185529b1296deb027f0896e6ed5", "sha256": "d8033bbc9e98169a00efb36aac2633dd9e78d15bddaa76c0f8e51ebe443db943" }, "downloads": -1, "filename": "docpy-0.1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "a6f32185529b1296deb027f0896e6ed5", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 5097, "upload_time": "2019-08-22T18:31:58", "url": "https://files.pythonhosted.org/packages/38/dc/ff1299b59b5ad0cecc6f4a81c0c316a0111215fdcc2e3e6671396076d8aa/docpy-0.1.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "b82aca0e5e67060b32cdd105aaf300a3", "sha256": "c51adab89d33859c62f2fc1f1ccccfc7eb79d6f67a22c574d6d1f975d34b5136" }, "downloads": -1, "filename": "docpy-0.1.1.tar.gz", "has_sig": false, "md5_digest": "b82aca0e5e67060b32cdd105aaf300a3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3568, "upload_time": "2019-08-22T18:32:00", "url": "https://files.pythonhosted.org/packages/bc/82/bec5e8c480dc40ff8a3bbbe8e9653b16e0cf7b5fb1b632db84c175279473/docpy-0.1.1.tar.gz" } ] }