{ "info": { "author": "Jordan Matelsky", "author_email": "opensource@fitmango.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: Apache Software License", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.6" ], "description": "\n

\n

d o c s h u n d

\n
simple code documentation generation
\n\n> NOTE: Docshund is in alpha and is not yet suitable for production workloads. Please exercise caution when using.\n\n# Installation\n\n```python\npip3 install docshund\n```\n\n# Usage\n\n```shell\ndocshund code.py > documentation.md\n```\n\n## What she do:\n\nGo from this:\n\n```python\nclass Foo:\n \"\"\"\n This is a foo.\n\n Do not cross the foo streams!\n \"\"\"\n\n def __init__(self):\n \"\"\"\n Create a new foo.\n \"\"\"\n\n def cross_streams(self, other_foo: Foo = None):\n \"\"\"\n Cross the streams of this foo with another foo.\n\n If you do this, it will throw an error.\n\n Arguments:\n other_foo (Foo: None): The foo with which you'd like to cross streams\n\n Returns:\n None\n\n Raises:\n FooError: Raised if you cross the streams.\n\n \"\"\"\n if other_foo:\n raise FooError(\"What did we JUST tell you?!\")\n```\n\nTo this markdown:\n\n```\n## *Class* `Foo`\n\n\nThis is a foo.\n\nDo not cross the foo streams!\n\n\n## *Function* `__init__(self)`\n\n\nCreate a new foo.\n\n\n## *Function* `cross_streams(self, other_foo: Foo = None)`\n\n\nCross the streams of this foo with another foo.\n\nIf you do this, it will throw an error.\n\n### Arguments\n> - **other_foo** (`Foo`: `None`): The foo with which you'd like to cross streams\n\n### Returns\n None\n\n### Raises\n> - **FooError** (`None`: `None`): Raised if you cross the streams.\n```\n\n## *Class* `Foo`\n\n\nThis is a foo.\n\nDo not cross the foo streams!\n\n\n## *Function* `__init__(self)`\n\n\nCreate a new foo.\n\n\n## *Function* `cross_streams(self, other_foo: Foo = None)`\n\n\nCross the streams of this foo with another foo.\n\nIf you do this, it will throw an error.\n\n### Arguments\n> - **other_foo** (`Foo`: `None`): The foo with which you'd like to cross streams\n\n### Returns\n None\n\n### Raises\n> - **FooError** (`None`: `None`): Raised if you cross the streams.\n---\n\n# Generating documentation for this repository\n\nThe reference documentation for this repository was generated using the following command:\n\n```shell\ndocshund docshund/__init__.py > docs/Reference.md\n```\n\nYou might say we... \ud83d\ude0e ate our own dogfood.\n\n---\n\n## Legal\n\nLicensed under Apache 2.0. Reach out to opensource@fitmango.com with questions.\n\n> Copyright 2019 FitMango.\n>\n> Licensed under the Apache License, Version 2.0 (the \"License\");\n> you may not use this codebase except in compliance with the License.\n> You may obtain a copy of the License at\n>\n> http://www.apache.org/licenses/LICENSE-2.0\n>\n> Unless required by applicable law or agreed to in writing, software\n> distributed under the License is distributed on an \"AS IS\" BASIS,\n> WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n> See the License for the specific language governing permissions and\n> limitations under the License.\n\n---\n\n
Made with \u2764\ufe0f at \ud83e\udd6d
\n\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/FitMango/docshund", "keywords": "", "license": "Apache License 2.0", "maintainer": "", "maintainer_email": "", "name": "docshund", "package_url": "https://pypi.org/project/docshund/", "platform": "", "project_url": "https://pypi.org/project/docshund/", "project_urls": { "Homepage": "https://github.com/FitMango/docshund" }, "release_url": "https://pypi.org/project/docshund/0.1.0/", "requires_dist": [ "pytest ; extra == 'dev'", "pylint ; extra == 'dev'" ], "requires_python": ">=3.6.0", "summary": "docshund: a doc dog.", "version": "0.1.0" }, "last_serial": 5659772, "releases": { "0.1.0": [ { "comment_text": "", "digests": { "md5": "ac51a0cbed46221b0e828d66b6378593", "sha256": "656c54c6c7db69ab76064d97e86698104fb7e85603a30afad4620599b0e66b3b" }, "downloads": -1, "filename": "docshund-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "ac51a0cbed46221b0e828d66b6378593", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=3.6.0", "size": 9811, "upload_time": "2019-08-10T16:14:59", "url": "https://files.pythonhosted.org/packages/e1/07/cff63f3c90f65c816bcc3f03be3a4e07d54ba9cb41dae15d8a12588b88e3/docshund-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c0361de8879a9ea9fb853f1507dbcbc2", "sha256": "bb5617bb94aae3dc1069a184558a098ceff1fff591e009f925f1a6f3a2c27dc0" }, "downloads": -1, "filename": "docshund-0.1.0.tar.gz", "has_sig": false, "md5_digest": "c0361de8879a9ea9fb853f1507dbcbc2", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6.0", "size": 5995, "upload_time": "2019-08-10T16:15:01", "url": "https://files.pythonhosted.org/packages/e8/55/129b85f28bfd3d5271b8ab84e3b11742ef5e7e9535f6b03f7d896d12930e/docshund-0.1.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "ac51a0cbed46221b0e828d66b6378593", "sha256": "656c54c6c7db69ab76064d97e86698104fb7e85603a30afad4620599b0e66b3b" }, "downloads": -1, "filename": "docshund-0.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "ac51a0cbed46221b0e828d66b6378593", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=3.6.0", "size": 9811, "upload_time": "2019-08-10T16:14:59", "url": "https://files.pythonhosted.org/packages/e1/07/cff63f3c90f65c816bcc3f03be3a4e07d54ba9cb41dae15d8a12588b88e3/docshund-0.1.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c0361de8879a9ea9fb853f1507dbcbc2", "sha256": "bb5617bb94aae3dc1069a184558a098ceff1fff591e009f925f1a6f3a2c27dc0" }, "downloads": -1, "filename": "docshund-0.1.0.tar.gz", "has_sig": false, "md5_digest": "c0361de8879a9ea9fb853f1507dbcbc2", "packagetype": "sdist", "python_version": "source", "requires_python": ">=3.6.0", "size": 5995, "upload_time": "2019-08-10T16:15:01", "url": "https://files.pythonhosted.org/packages/e8/55/129b85f28bfd3d5271b8ab84e3b11742ef5e7e9535f6b03f7d896d12930e/docshund-0.1.0.tar.gz" } ] }