{"repo":"pdoc3/pdoc","free":true,"listed":false,"github":"https://github.com/pdoc3/pdoc","clone":"git clone https://github.com/pdoc3/pdoc.git","description":"🐍 ➡️ 📜 Auto-generate API docs for Python projects","language":"Python","stars":1186,"topics":["documentation","generator","documentation-generator","documentation-tool","documentation-dumper","api-documentation","python","python3","docs","docs-generator"],"license":"AGPL-3.0","category":"docs-static-sites","readme_excerpt":"pdoc ==== Auto-generate API documentation for Python 3+ projects. Project website [Documentation] [Documentation]: https://pdoc3.github.io/pdoc/doc/pdoc/ Installation ------------ $ pip install pdoc3 Usage ----- Pdoc will accept a Python module file, package directory or an import path. $ pdoc your project See pdoc --help for more command-line switches and the [documentation] for more usage examples. Features -------- Simple usage. Generate sensible API (+ prose) documentation without any special configuration. Support for common [docstrings formats] (Markdown, numpydoc, Google-style docstrings), LaTeX math, and some [reST directives]. Support for [PEP 484] and [PEP 526] type annotations. pdoc respects [ all ] when present. Docstrings for overridden class members are [inherited] if unspecified. Support for documenting module, class, and instance [ variables ] by traversing ASTs. Automatic [cross-linking] of referenced identifiers. Overriding docstrings generation with special module-level [ pdoc dictionary]. Easily extended and [customized templates]. Built-in [development web server] for near-instant preview of rendered docstrings. The above features are explained in more detail in pdoc's [documentation] (generated with pdoc). [docstrings formats]: https://pdoc3.github.io/pdoc/doc/pdoc/#supported-docstring-formats [reST directives]: https://pdoc3.github.io/pdoc/doc/pdoc/#supported-rest-directives [PEP 484]: https://www.python.org/dev/peps/pep-0484/ [PEP 526]: https://www.pyt","default_branch":null,"files":null,"tree":[],"storefront":"/r/pdoc3","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/pdoc3/pdoc/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}