{ "info": { "author": "Tyler Trussell", "author_email": "tigertrussell+pip@gmail.com", "bugtrack_url": null, "classifiers": [], "description": "# catnado-docgen\n\nA Python documentation utility designed to work with `mkdocs`.\n\nOriginally built for [`gae-catnado`](https://tylertrussell.github.io/gae-catnado),\nbut could be useful for other projects, too.\n\nInstall via `pip install catnado-docgen`.\n\n**This is a work in progress!** Expect bugs and unannounced changes.\n\nReal changelog to follow.\n\n## Instructions\n\n\n#### In conjunction with `mkdocs.yaml`\n\nTo document a package in a project that has a `mkdocs.yaml` file, simply run:\n```\ndocgen build packagename mkdocs.yml --update-pages\n```\n\nThis scans `packagename` recursively, extracting Python docstrings and building\nMarkdown source files from them.\n\nThe new Markdown files are written to a folder called `docgen-api` in your \n`docs_dir` (as specified in `mkdocs.yml`).\n\nThe `--update-pages` option updates the `mkdocs.yml` `pages` entry to contain a \nnested structure of packages and submodules under the heading `docgen-api`.\n\n\n#### Without `mkdocs.yml`\n\nIf you want to do something else with the generated markdown documents, you can\njust specify an output directory like so:\n\n`docgen build packagename /my/path/here`\n\nThis will write the Markdown source to the specified directory.\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/tylertrussell/catnado-docgen", "keywords": "python documentation generation mkdocs", "license": "Apache 2.0", "maintainer": "", "maintainer_email": "", "name": "catnado-docgen", "package_url": "https://pypi.org/project/catnado-docgen/", "platform": "", "project_url": "https://pypi.org/project/catnado-docgen/", "project_urls": { "Homepage": "http://github.com/tylertrussell/catnado-docgen" }, "release_url": "https://pypi.org/project/catnado-docgen/0.0.1.dev2/", "requires_dist": null, "requires_python": "", "summary": "A Python documentation utility.", "version": "0.0.1.dev2" }, "last_serial": 3955462, "releases": { "0.0.1.dev1": [ { "comment_text": "", "digests": { "md5": "6a85f233b45e7f28c40534bbbec3922c", "sha256": "67c172248433640191a07cc8dbe1234886468be5b0e6e23e64e7702362870d78" }, "downloads": -1, "filename": "catnado_docgen-0.0.1.dev1-py2-none-any.whl", "has_sig": false, "md5_digest": "6a85f233b45e7f28c40534bbbec3922c", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 7625, "upload_time": "2018-06-05T04:52:25", "url": "https://files.pythonhosted.org/packages/56/13/e5639a575b9c7c35fca895ff20ed886adabb661c8a70c37940efeed4059e/catnado_docgen-0.0.1.dev1-py2-none-any.whl" } ], "0.0.1.dev2": [ { "comment_text": "", "digests": { "md5": "ac44de905b551e79e78d5c682eec8619", "sha256": "d4c6dc3da3cc4530ee942b3b2fda206fe06ba2558b2af0e43eb632fcba5c625d" }, "downloads": -1, "filename": "catnado_docgen-0.0.1.dev2-py2-none-any.whl", "has_sig": false, "md5_digest": "ac44de905b551e79e78d5c682eec8619", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 7625, "upload_time": "2018-06-12T21:25:54", "url": "https://files.pythonhosted.org/packages/f6/54/fbd5923b9c748c233d7ba80092f7d6bd1abc93c7501abe034ce6cf86931b/catnado_docgen-0.0.1.dev2-py2-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "ac44de905b551e79e78d5c682eec8619", "sha256": "d4c6dc3da3cc4530ee942b3b2fda206fe06ba2558b2af0e43eb632fcba5c625d" }, "downloads": -1, "filename": "catnado_docgen-0.0.1.dev2-py2-none-any.whl", "has_sig": false, "md5_digest": "ac44de905b551e79e78d5c682eec8619", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 7625, "upload_time": "2018-06-12T21:25:54", "url": "https://files.pythonhosted.org/packages/f6/54/fbd5923b9c748c233d7ba80092f7d6bd1abc93c7501abe034ce6cf86931b/catnado_docgen-0.0.1.dev2-py2-none-any.whl" } ] }