pdoc3 0.11.1

Auto-generate API documentation for Python projects.

Stars: 1127, Watchers: 1127, Forks: 145, Open Issues: 115

The pdoc3/pdoc repo was created 5 years ago and the last code push was 1 months ago.
The project is very popular with an impressive 1127 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

None

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

Related Packages

Errors

A list of common pdoc3 errors.

Code Examples

Here are some pdoc3 code examples and snippets.

GitHub Issues

The pdoc3 package has 115 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