Contents

pdoc3 0.10.0

0

Auto-generate API documentation for Python projects.

Auto-generate API documentation for Python projects.

Stars: 1068, Watchers: 1068, Forks: 148, Open Issues: 123

The pdoc3/pdoc repo was created 5 years ago and the last code push was 1 weeks ago.
The project is very popular with an impressive 1068 github stars!

How to Install pdoc3

You can install pdoc3 using pip

pip install pdoc3

or add it to a project with poetry

poetry add pdoc3

Package Details

Author
License
AGPL-3.0
Homepage
https://pdoc3.github.io/pdoc/
PyPi:
https://pypi.org/project/pdoc3/
Documentation:
https://pdoc3.github.io/pdoc/doc/pdoc/
GitHub Repo:
https://github.com/pdoc3/pdoc

Classifiers

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

Errors

A list of common pdoc3 errors.

Code Examples

Here are some pdoc3 code examples and snippets.

GitHub Issues

The pdoc3 package has 123 open issues on GitHub

  • pdoc3 doesn't use the latest version of the python file
  • Dataclass arguments should not be interpreted as static members
  • pdoc3 programmatic-usage example
  • enable showing private methods/variables
  • Exclude empty submodule from docs
  • documentation root folder and links to child pages
  • Introduce option for hljs-meta tags to not be user-selectable.
  • The idea for documenting reimported entities from submodules
  • Lunr search with –http mode
  • ENH: Add support for reST-style docstrings
  • Offline html output
  • Include pages (e.g. notebooks)

See more issues on GitHub

Related Packages & Articles

mypy-boto3-sqs 1.34.0

Type annotations for boto3.SQS 1.34.0 service generated with mypy-boto3-builder 7.21.0