{ "info": { "author": "", "author_email": "", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Intended Audience :: Developers", "License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)", "Operating System :: OS Independent", "Programming Language :: Python :: 3 :: Only", "Topic :: Documentation", "Topic :: Software Development :: Documentation", "Topic :: Utilities" ], "description": "[![](https://i.imgur.com/kQOtbBk.png)](https://pdoc3.github.io/pdoc/)\n\npdoc\n====\n\n[![Build Status](https://img.shields.io/travis/pdoc3/pdoc.svg?style=for-the-badge)](https://travis-ci.org/pdoc3/pdoc)\n[![Code Coverage](https://img.shields.io/codecov/c/gh/pdoc3/pdoc.svg?style=for-the-badge)](https://codecov.io/gh/pdoc3/pdoc)\n[![pdoc3 on PyPI](https://img.shields.io/pypi/v/pdoc3.svg?color=blue&style=for-the-badge)](https://pypi.org/project/pdoc3)\n\nAuto-generate API documentation for Python projects.\n\n[**Project website**](https://pdoc3.github.io/pdoc/)\n\n[Documentation]\n\n[Documentation]: https://pdoc3.github.io/pdoc/doc/pdoc/\n\n\nInstallation\n------------\n\n $ pip install pdoc3\n\n\nUsage\n-----\nPdoc will accept a Python module file, package directory or an import path.\n\n $ pdoc your_project\n\nSee `pdoc --help` for more command-line switches and the [documentation]\nfor more usage examples.\n\n\nFeatures\n--------\n* Simple usage. Generate sensible API (+ prose) documentation without any\n special configuration.\n* Support for common docstrings formats (Markdown, numpydoc, Google-style docstrings),\n LaTeX math, and some reST directives.\n* Support for PEP 484 type annotations.\n* pdoc respects `__all__` when present.\n* Inheritance used as applicable for inferring docstrings for class members.\n* Support for documenting module, class, and instance variables by traversing ASTs.\n* Automatic cross-linking of referenced identifiers in HTML and PDF.\n* Overriding docstrings with special module-level `__pdoc__` dictionary.\n* Built-in development web server for near-instant preview of rendered docstrings.\n\nThe above features are explained in more detail in pdoc's [documentation]\n(which was generated with pdoc).", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://pdoc3.github.io/pdoc/", "keywords": "", "license": "AGPL-3.0", "maintainer": "", "maintainer_email": "", "name": "pdoc3", "package_url": "https://pypi.org/project/pdoc3/", "platform": "", "project_url": "https://pypi.org/project/pdoc3/", "project_urls": { "Documentation": "https://pdoc3.github.io/pdoc/doc/pdoc/", "Homepage": "https://pdoc3.github.io/pdoc/", "Source": "https://github.com/pdoc3/pdoc/", "Tracker": "https://github.com/pdoc3/pdoc/issues" }, "release_url": "https://pypi.org/project/pdoc3/0.7.1/", "requires_dist": null, "requires_python": ">= 3.5", "summary": "Auto-generate API documentation for Python projects.", "version": "0.7.1" }, "last_serial": 5921280, "releases": { "0.3.11": [ { "comment_text": "", "digests": { "md5": "052e5f3989989cfbc07087197ea3a07c", "sha256": "abc18da1912b1e51abe90a7ef3b8e58d7dc98f8371fde214f60682f5dd0a4393" }, "downloads": -1, "filename": "pdoc3-0.3.11.tar.gz", "has_sig": false, "md5_digest": "052e5f3989989cfbc07087197ea3a07c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 77878, "upload_time": "2019-01-24T16:14:38", "url": "https://files.pythonhosted.org/packages/10/78/de7f101b4fceaa63d7bea6f8d28da8c8f748bc7f5d51545230f1e95a3db5/pdoc3-0.3.11.tar.gz" } ], "0.5.0": [ { "comment_text": "", "digests": { "md5": "7c837f5869bb4ea2133422f87b9743a9", "sha256": "d98bcb5f7edf35e7d92bf7ca9b4886df4e766c78c3596f2939180a9ef913b11a" }, "downloads": -1, "filename": "pdoc3-0.5.0.tar.gz", "has_sig": false, "md5_digest": "7c837f5869bb4ea2133422f87b9743a9", "packagetype": "sdist", "python_version": "source", "requires_python": ">= 3.5", "size": 52360, "upload_time": "2019-01-10T13:44:13", "url": "https://files.pythonhosted.org/packages/4b/a4/ad54cb92f024cce700295a6cc2063f3766891467299e21a9633ac6c314d7/pdoc3-0.5.0.tar.gz" } ], "0.5.1": [ { "comment_text": "", "digests": { "md5": "dadece712c2cfa725c2491528a44b77d", "sha256": "41c1bcf7503495e7d4122076c6271313bf028adce5cd700f30cca17af13ca088" }, "downloads": -1, "filename": "pdoc3-0.5.1.tar.gz", "has_sig": false, "md5_digest": "dadece712c2cfa725c2491528a44b77d", "packagetype": "sdist", "python_version": "source", "requires_python": ">= 3.5", "size": 52343, "upload_time": "2019-01-12T14:10:31", "url": "https://files.pythonhosted.org/packages/37/c5/9bdeb263440b17fa274533e2b837f34b06803641c5673d2fdcfeb8803bc1/pdoc3-0.5.1.tar.gz" } ], "0.5.2": [ { "comment_text": "", "digests": { "md5": "aed950784d2a3dc84e212e6ba696414d", "sha256": "1124004173612e1afd7bed3e948aae56e2523f92050b4584f49e7c971474c23f" }, "downloads": -1, "filename": "pdoc3-0.5.2.tar.gz", "has_sig": false, "md5_digest": "aed950784d2a3dc84e212e6ba696414d", "packagetype": "sdist", "python_version": "source", "requires_python": ">= 3.5", "size": 54335, "upload_time": "2019-02-04T01:16:56", "url": "https://files.pythonhosted.org/packages/a7/c6/70de76835e95bd6997465d95516deabce5f0fb4c224512a2924c644e2be6/pdoc3-0.5.2.tar.gz" } ], "0.5.3": [ { "comment_text": "", "digests": { "md5": "a7118a121e34c188b62b5ef7de4a8f5d", "sha256": "8e11ef161c3dcd68d5a434d38ae55e2f8f5719470429d64e9b187d87e5f1d8d6" }, "downloads": -1, "filename": "pdoc3-0.5.3.tar.gz", "has_sig": false, "md5_digest": "a7118a121e34c188b62b5ef7de4a8f5d", "packagetype": "sdist", "python_version": "source", "requires_python": ">= 3.5", "size": 56637, "upload_time": "2019-03-05T14:07:42", "url": "https://files.pythonhosted.org/packages/85/dd/860a5305706f7e728912ad446b5b5ba1bebd6ee9f8e92c29456b1ab5b734/pdoc3-0.5.3.tar.gz" } ], "0.5.4": [ { "comment_text": "", "digests": { "md5": "eb8f7b972f38b138e2c1290cabc018f9", "sha256": "6babd3d47e607d579ddba268dbe4c21aa54d4e7f29a514b8af4372636f038ead" }, "downloads": -1, "filename": "pdoc3-0.5.4.tar.gz", "has_sig": false, "md5_digest": "eb8f7b972f38b138e2c1290cabc018f9", "packagetype": "sdist", "python_version": "source", "requires_python": ">= 3.5", "size": 57104, "upload_time": "2019-04-21T13:19:46", "url": "https://files.pythonhosted.org/packages/e2/87/317dd24867846221539c383446483055e9890b45d7b25916989c93155d12/pdoc3-0.5.4.tar.gz" } ], "0.6.0": [ { "comment_text": "", "digests": { "md5": "ca7dcba2131ddaef5c19be54f15e5c13", "sha256": "d40d581cbeeb31a7e269326940448b0f0b27500aeff3e5c73613bf99a840e788" }, "downloads": -1, "filename": "pdoc3-0.6.0.tar.gz", "has_sig": false, "md5_digest": "ca7dcba2131ddaef5c19be54f15e5c13", "packagetype": "sdist", "python_version": "source", "requires_python": ">= 3.5", "size": 62470, "upload_time": "2019-05-03T16:52:17", "url": "https://files.pythonhosted.org/packages/2a/91/e37dcb95afac1fd37222b8d928aab33ab735e2d18dedf9ba7ff99b897d4d/pdoc3-0.6.0.tar.gz" } ], "0.6.1": [ { "comment_text": "", "digests": { "md5": "5cbf1874cf2f2283f098672b3d507131", "sha256": "24b4c012a89c573742a41f8239a71249060e3484baf16d4f489baec788313182" }, "downloads": -1, "filename": "pdoc3-0.6.1.tar.gz", "has_sig": false, "md5_digest": "5cbf1874cf2f2283f098672b3d507131", "packagetype": "sdist", "python_version": "source", "requires_python": ">= 3.5", "size": 62426, "upload_time": "2019-05-05T01:48:00", "url": "https://files.pythonhosted.org/packages/6a/ba/a53acee4609bcbc874e982dfd5a3b0630a6deffead2db86d3bfaafb517a3/pdoc3-0.6.1.tar.gz" } ], "0.6.2": [ { "comment_text": "", "digests": { "md5": "878a6dbf4a682fc3111826722874e750", "sha256": "bfc011da61a3edd4bb1ec2b8dcaa483776b67a30bf67a28760ab25edd9dc502c" }, "downloads": -1, "filename": "pdoc3-0.6.2.tar.gz", "has_sig": false, "md5_digest": "878a6dbf4a682fc3111826722874e750", "packagetype": "sdist", "python_version": "source", "requires_python": ">= 3.5", "size": 63742, "upload_time": "2019-05-20T17:48:50", "url": "https://files.pythonhosted.org/packages/51/96/bf85b7bd7c18c8f6f4f85720875de817f124da3ee1d07adea84c20cbbe67/pdoc3-0.6.2.tar.gz" } ], "0.6.3": [ { "comment_text": "", "digests": { "md5": "57f086884843b8cb3944225bebe7caef", "sha256": "b144f61eb1f790e998dbbbe32785cd48eba587ebae00cfcf1a2408c8f4ffaca2" }, "downloads": -1, "filename": "pdoc3-0.6.3.tar.gz", "has_sig": false, "md5_digest": "57f086884843b8cb3944225bebe7caef", "packagetype": "sdist", "python_version": "source", "requires_python": ">= 3.5", "size": 65430, "upload_time": "2019-07-03T12:20:43", "url": "https://files.pythonhosted.org/packages/31/0c/0228d25f94bef5c529365c77ee4364787cb6802e2401deb5c55c120b8227/pdoc3-0.6.3.tar.gz" } ], "0.6.4": [ { "comment_text": "", "digests": { "md5": "4d8735a36a5f05ac3de80fcf0804dd66", "sha256": "85cbb0de17d1306157d19b08b67ad84817098c12ad9f92ec203b79d0307b6a25" }, "downloads": -1, "filename": "pdoc3-0.6.4.tar.gz", "has_sig": false, "md5_digest": "4d8735a36a5f05ac3de80fcf0804dd66", "packagetype": "sdist", "python_version": "source", "requires_python": ">= 3.5", "size": 65722, "upload_time": "2019-09-26T21:10:50", "url": "https://files.pythonhosted.org/packages/32/57/ae74ea7278b2f0ba22cfee4f872fb236f7abeb3218353ae9126945ed951b/pdoc3-0.6.4.tar.gz" } ], "0.7.0": [ { "comment_text": "", "digests": { "md5": "3fb29500fd80c236b2004463e3b3a311", "sha256": "f4a27fa0cc8cf6fb8772129a9d7e9ecb3bab72a6ffd2475c5ad861484f6aae3d" }, "downloads": -1, "filename": "pdoc3-0.7.0.tar.gz", "has_sig": false, "md5_digest": "3fb29500fd80c236b2004463e3b3a311", "packagetype": "sdist", "python_version": "source", "requires_python": ">= 3.5", "size": 67783, "upload_time": "2019-09-26T22:42:28", "url": "https://files.pythonhosted.org/packages/c6/e9/32ef1c81e2716c854d5eaadd86f315d9217c7c8d1acf60a95855e0f3b932/pdoc3-0.7.0.tar.gz" } ], "0.7.1": [ { "comment_text": "", "digests": { "md5": "beec953447c76bc6e00bcf5f2d22548c", "sha256": "c2cff1fc7a36b45be6e76561b0bd5a5b829ee7c5bb22e6338cfd891d460758c9" }, "downloads": -1, "filename": "pdoc3-0.7.1.tar.gz", "has_sig": false, "md5_digest": "beec953447c76bc6e00bcf5f2d22548c", "packagetype": "sdist", "python_version": "source", "requires_python": ">= 3.5", "size": 67921, "upload_time": "2019-10-03T01:34:25", "url": "https://files.pythonhosted.org/packages/7b/87/4bf1b71f4d357f96f768bf5df07a6a9a36e3571bf5df960441121c0f1cdc/pdoc3-0.7.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "beec953447c76bc6e00bcf5f2d22548c", "sha256": "c2cff1fc7a36b45be6e76561b0bd5a5b829ee7c5bb22e6338cfd891d460758c9" }, "downloads": -1, "filename": "pdoc3-0.7.1.tar.gz", "has_sig": false, "md5_digest": "beec953447c76bc6e00bcf5f2d22548c", "packagetype": "sdist", "python_version": "source", "requires_python": ">= 3.5", "size": 67921, "upload_time": "2019-10-03T01:34:25", "url": "https://files.pythonhosted.org/packages/7b/87/4bf1b71f4d357f96f768bf5df07a6a9a36e3571bf5df960441121c0f1cdc/pdoc3-0.7.1.tar.gz" } ] }