| Name | pdoc3 JSON |
| Version |
0.11.5
JSON |
| download |
| home_page | https://pdoc3.github.io/pdoc/ |
| Summary | Auto-generate API documentation for Python projects. |
| upload_time | 2024-12-13 17:40:18 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | AGPL-3.0 |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://pdoc3.github.io/pdoc/)
pdoc
====
[](https://github.com/pdoc3/pdoc/actions)
[](https://codecov.io/gh/pdoc3/pdoc)
[](https://pypi.org/project/pdoc3)
[](https://pypi.org/project/pdoc3)
[](https://github.com/sponsors/kernc)
Auto-generate API documentation for Python 3+ projects.
[**Project website**](https://pdoc3.github.io/pdoc/)
[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.python.org/dev/peps/pep-0526/
[`__all__`]: https://pdoc3.github.io/pdoc/doc/pdoc/#what-objects-are-documented
[inherited]: https://pdoc3.github.io/pdoc/doc/pdoc/#docstrings-inheritance
[_variables_]: https://pdoc3.github.io/pdoc/doc/pdoc/#docstrings-for-variables
[cross-linking]: https://pdoc3.github.io/pdoc/doc/pdoc/#linking-to-other-identifiers
[`__pdoc__` dictionary]: https://pdoc3.github.io/pdoc/doc/pdoc/#overriding-docstrings-with-__pdoc__
[customized templates]: https://pdoc3.github.io/pdoc/doc/pdoc/#custom-templates
[development web server]: https://pdoc3.github.io/pdoc/doc/pdoc/#command-line-interface
Development
-----------
Check [CONTRIBUTING.md](CONTRIBUTING.md) for hacking details.
Raw data
{
"_id": null,
"home_page": "https://pdoc3.github.io/pdoc/",
"name": "pdoc3",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/8b/40/669cb485321fa41ee87e2e6e05280baf394fa06d3430bb3c260db860ef6a/pdoc3-0.11.5.tar.gz",
"platform": null,
"description": "[](https://pdoc3.github.io/pdoc/)\n\npdoc\n====\n[](https://github.com/pdoc3/pdoc/actions)\n[](https://codecov.io/gh/pdoc3/pdoc)\n[](https://pypi.org/project/pdoc3)\n[](https://pypi.org/project/pdoc3)\n[](https://github.com/sponsors/kernc)\n\nAuto-generate API documentation for Python 3+ 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] and [PEP 526] type annotations.\n* pdoc respects [`__all__`] when present.\n* Docstrings for overridden class members are [inherited] if unspecified.\n* Support for documenting module, class, and instance [_variables_] by traversing ASTs.\n* Automatic [cross-linking] of referenced identifiers.\n* Overriding docstrings generation with special module-level [`__pdoc__` dictionary].\n* Easily extended and [customized templates].\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(generated with pdoc).\n\n[docstrings formats]: https://pdoc3.github.io/pdoc/doc/pdoc/#supported-docstring-formats\n[reST directives]: https://pdoc3.github.io/pdoc/doc/pdoc/#supported-rest-directives\n[PEP 484]: https://www.python.org/dev/peps/pep-0484/\n[PEP 526]: https://www.python.org/dev/peps/pep-0526/\n[`__all__`]: https://pdoc3.github.io/pdoc/doc/pdoc/#what-objects-are-documented\n[inherited]: https://pdoc3.github.io/pdoc/doc/pdoc/#docstrings-inheritance\n[_variables_]: https://pdoc3.github.io/pdoc/doc/pdoc/#docstrings-for-variables\n[cross-linking]: https://pdoc3.github.io/pdoc/doc/pdoc/#linking-to-other-identifiers\n[`__pdoc__` dictionary]: https://pdoc3.github.io/pdoc/doc/pdoc/#overriding-docstrings-with-__pdoc__\n[customized templates]: https://pdoc3.github.io/pdoc/doc/pdoc/#custom-templates\n[development web server]: https://pdoc3.github.io/pdoc/doc/pdoc/#command-line-interface\n\n\nDevelopment\n-----------\nCheck [CONTRIBUTING.md](CONTRIBUTING.md) for hacking details.\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "Auto-generate API documentation for Python projects.",
"version": "0.11.5",
"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"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7024a1294c6108c9a887bebed876479c62f616be4e832bf94811b12d1c369f63",
"md5": "afd0b13b1185ead28522f2f586d023a8",
"sha256": "b614436239716e1655e538f68a42c62a0bac566e70ddd86c58bc66d6a9ec90a0"
},
"downloads": -1,
"filename": "pdoc3-0.11.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "afd0b13b1185ead28522f2f586d023a8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 144100,
"upload_time": "2024-12-13T17:40:16",
"upload_time_iso_8601": "2024-12-13T17:40:16.298289Z",
"url": "https://files.pythonhosted.org/packages/70/24/a1294c6108c9a887bebed876479c62f616be4e832bf94811b12d1c369f63/pdoc3-0.11.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8b40669cb485321fa41ee87e2e6e05280baf394fa06d3430bb3c260db860ef6a",
"md5": "84bc1256519239e49c549fcfa03f2d54",
"sha256": "fc40607e3f46860ba42c02d30075fe1a52c039b77ffa8e86c1cbc4a8078841b3"
},
"downloads": -1,
"filename": "pdoc3-0.11.5.tar.gz",
"has_sig": false,
"md5_digest": "84bc1256519239e49c549fcfa03f2d54",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 99496,
"upload_time": "2024-12-13T17:40:18",
"upload_time_iso_8601": "2024-12-13T17:40:18.088355Z",
"url": "https://files.pythonhosted.org/packages/8b/40/669cb485321fa41ee87e2e6e05280baf394fa06d3430bb3c260db860ef6a/pdoc3-0.11.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-13 17:40:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pdoc3",
"github_project": "pdoc",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pdoc3"
}
