pdoc3


Namepdoc3 JSON
Version 0.11.1 PyPI version JSON
download
home_pagehttps://pdoc3.github.io/pdoc/
SummaryAuto-generate API documentation for Python projects.
upload_time2024-06-26 13:46:20
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseAGPL-3.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            [![](https://i.imgur.com/kQOtbBk.png)](https://pdoc3.github.io/pdoc/)

pdoc
====
[![Build Status](https://img.shields.io/github/actions/workflow/status/pdoc3/pdoc/ci.yml?branch=master&style=for-the-badge)](https://github.com/pdoc3/pdoc/actions)
[![Code Coverage](https://img.shields.io/codecov/c/gh/pdoc3/pdoc.svg?style=for-the-badge)](https://codecov.io/gh/pdoc3/pdoc)
[![pdoc3 on PyPI](https://img.shields.io/pypi/v/pdoc3.svg?color=blue&style=for-the-badge)](https://pypi.org/project/pdoc3)
[![package downloads](https://img.shields.io/pypi/dm/pdoc3.svg?color=skyblue&style=for-the-badge)](https://pypi.org/project/pdoc3)
[![GitHub Sponsors](https://img.shields.io/github/sponsors/kernc?color=pink&style=for-the-badge)](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/40/a3/141d32ae6abfdd17f0314a3f6b93ce83becefc7f0f71f5902b6b8b993cd7/pdoc3-0.11.1.tar.gz",
    "platform": null,
    "description": "[![](https://i.imgur.com/kQOtbBk.png)](https://pdoc3.github.io/pdoc/)\n\npdoc\n====\n[![Build Status](https://img.shields.io/github/actions/workflow/status/pdoc3/pdoc/ci.yml?branch=master&style=for-the-badge)](https://github.com/pdoc3/pdoc/actions)\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[![package downloads](https://img.shields.io/pypi/dm/pdoc3.svg?color=skyblue&style=for-the-badge)](https://pypi.org/project/pdoc3)\n[![GitHub Sponsors](https://img.shields.io/github/sponsors/kernc?color=pink&style=for-the-badge)](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.1",
    "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": "40a3141d32ae6abfdd17f0314a3f6b93ce83becefc7f0f71f5902b6b8b993cd7",
                "md5": "98fe4a644f95c9ef58163484507cad5b",
                "sha256": "20bf2aad8110892573fd350b1bf95f6612b53b55e29b0fc143b5f2b5bcbabfb6"
            },
            "downloads": -1,
            "filename": "pdoc3-0.11.1.tar.gz",
            "has_sig": false,
            "md5_digest": "98fe4a644f95c9ef58163484507cad5b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 97928,
            "upload_time": "2024-06-26T13:46:20",
            "upload_time_iso_8601": "2024-06-26T13:46:20.088559Z",
            "url": "https://files.pythonhosted.org/packages/40/a3/141d32ae6abfdd17f0314a3f6b93ce83becefc7f0f71f5902b6b8b993cd7/pdoc3-0.11.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-26 13:46:20",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "pdoc3",
    "github_project": "pdoc",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pdoc3"
}
None
Elapsed time: 0.28261s