Contents

pdoc 16.0.0

0

API Documentation for Python Projects

API Documentation for Python Projects

Stars: 2459, Watchers: 2459, Forks: 214, Open Issues: 56

The mitmproxy/pdoc repo was created 12 years ago and the last code push was 2 weeks ago.
The project is very popular with an impressive 2459 github stars!

How to Install pdoc

You can install pdoc using pip

pip install pdoc

or add it to a project with poetry

poetry add pdoc

Package Details

Author
None
License
MIT-0
Homepage
None
PyPi:
https://pypi.org/project/pdoc/
Documentation:
https://pdoc.dev/docs/pdoc.html
GitHub Repo:
https://github.com/mitmproxy/pdoc

Classifiers

  • Documentation
  • Software Development/Documentation
  • Utilities
No  pdoc  pypi packages just yet.

Errors

A list of common pdoc errors.

Code Examples

Here are some pdoc code examples and snippets.

GitHub Issues

The pdoc package has 56 open issues on GitHub

  • md5 hash in table of contents when markdown header is inline code
  • pdoc is raising exception if using in project using pydantic v1
  • pdoc treats overridden methods as inherited when mixing Generic[…] base class with non-generic ABC in multiple inheritance
  • Matrix with two rows appears smooshed into a single line
  • include local logo assets in pdoc output

See more issues on GitHub

Related Packages & Articles

censys 2.2.19

An easy-to-use and lightweight API wrapper for Censys APIs (censys.io).

apispec 6.9.0

A pluggable API specification generator. Currently supports the OpenAPI Specification (f.k.a. the Swagger specification).

fastapi 0.129.0

FastAPI framework, high performance, easy to learn, fast to code, ready for production