{ "info": { "author": "Taylor Brazelton", "author_email": "ryanb58@live.com", "bugtrack_url": null, "classifiers": [], "description": "# TDoc\r\nA python documentation generator.\r\n\r\n\r\n### Installation\r\n\r\n```\r\npip install tdoc\r\n```\r\n[pypi](https://pypi.python.org/pypi/tdoc)\r\n\r\n\r\n\r\n### Generate the markdown documentation.\r\n\r\n```\r\ntdoc generate --folder ./testfiles\r\n```\r\n\r\n### Run a local webserver to view your documentation.\r\n\r\n```\r\ntdoc serve\r\n```\r\n\r\n### Non Auto Generated Docs:\r\n\r\nTo include custom markdown files simply create a folder called\r\n`default_docs` and place any and all markdown files inside of it. This\r\ndirectory will be copied over into the `docs` folder before any auto\r\ngeneration.\r\n\r\n### Screenshot of Results using the Material Theme:\r\n\r\n![Screen Shot](imgs/screenshot.png?raw=true \"Screen Shot\")\r\n\r\n\r\n### Installing As Editable:\r\n\r\n```\r\npip install --editable .\r\n```", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/Ryanb58/tdoc", "keywords": "doc,gen,api,ast,auto", "license": "", "maintainer": "", "maintainer_email": "", "name": "tdoc", "package_url": "https://pypi.org/project/tdoc/", "platform": "", "project_url": "https://pypi.org/project/tdoc/", "project_urls": { "Homepage": "https://github.com/Ryanb58/tdoc" }, "release_url": "https://pypi.org/project/tdoc/0.2/", "requires_dist": [ "Click", "mkdocs" ], "requires_python": "", "summary": "Python To Markdown Documentation Tool", "version": "0.2" }, "last_serial": 2818079, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "aa665378a89fcda2b229bd13733ac7bc", "sha256": "d7506429a96a5ebdee7c2a0118d9ce8785a7bb294375b9c0dda56e52bc081a15" }, "downloads": -1, "filename": "tdoc-0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "aa665378a89fcda2b229bd13733ac7bc", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4435, "upload_time": "2017-04-15T06:38:42", "url": "https://files.pythonhosted.org/packages/89/d1/63db13db7e91dbc37bd2c20a4b49c1061278691d97e9c82fdf496303a7c5/tdoc-0.1-py3-none-any.whl" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "31aa031b1c9d5b28b491499c66001fea", "sha256": "d6cc222de3515c2b08ba53f33c9f61805b2d32925ca61f922153b143a41bd119" }, "downloads": -1, "filename": "tdoc-0.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "31aa031b1c9d5b28b491499c66001fea", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 4433, "upload_time": "2017-04-20T21:39:51", "url": "https://files.pythonhosted.org/packages/22/40/6c8f6e7c8e5b1f22b4847d313fc8c2ab6114c63e9b8885f3aa99cf27607c/tdoc-0.2-py2.py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "31aa031b1c9d5b28b491499c66001fea", "sha256": "d6cc222de3515c2b08ba53f33c9f61805b2d32925ca61f922153b143a41bd119" }, "downloads": -1, "filename": "tdoc-0.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "31aa031b1c9d5b28b491499c66001fea", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 4433, "upload_time": "2017-04-20T21:39:51", "url": "https://files.pythonhosted.org/packages/22/40/6c8f6e7c8e5b1f22b4847d313fc8c2ab6114c63e9b8885f3aa99cf27607c/tdoc-0.2-py2.py3-none-any.whl" } ] }