- Home
- Documentation Generators
- PyDoctor
On the recordRead 5 Oct 202623 facts
PyDoctor
On the record
- API pages
- Pydoctor generates a page for each class, module, and package, and presents information using tables.pydoctor.readthedocs.io · read 5 Oct 2026
- Best fit
- The FAQ describes PyDoctor as probably best suited to documenting libraries with some degree of internal subclassing.pydoctor.readthedocs.io · read 5 Oct 2026
- Configuration
- Pydoctor supports configuration through pydoctor.ini, pyproject.toml, and setup.cfg files.pydoctor.readthedocs.io · read 5 Oct 2026
- Customization
- The CLI provides options for themes, custom HTML templates, and which API objects to document.pydoctor.readthedocs.io · read 5 Oct 2026
- Docstring formats
- It supports epytext, reStructuredText, Google-style, NumPy-style, and plain text docstrings.github.com · read 5 Oct 2026
- Generated output
- PyDoctor generates static HTML pages that need no additional server-side support.pydoctor.readthedocs.io · read 5 Oct 2026
- Imports and inheritance
- It resolves imports and computes inheritance hierarchies.github.com · read 5 Oct 2026
- Inheritance and imports
- The tool works to resolve imports and calculate inheritance hierarchies.pydoctor.readthedocs.io · read 5 Oct 2026
- Installation
- The documentation gives installation instructions through PyPI with pip and on Debian derivatives with apt.pydoctor.readthedocs.io · read 5 Oct 2026
- Intended users
- The documentation says pydoctor is probably best suited to documenting libraries with some degree of internal subclassing.pydoctor.readthedocs.io · read 5 Oct 2026
- Interface support
- It supports zope.interface and can show which classes implement which interfaces, and vice versa.github.com · read 5 Oct 2026
- Maintainer context
- The FAQ says PyDoctor was written for the Twisted project, whose needs remain the main driving force for its development.pydoctor.readthedocs.io · read 5 Oct 2026
- Notable limitation
- Pydoctor cannot infer types for computed values, so those need annotations for the type to appear in the generated documentation.pydoctor.readthedocs.io · read 5 Oct 2026
- Notable Python version limit
- The project changelog says Python 3.8 support was dropped in version 25.4.0.github.com · read 5 Oct 2026
- Output
- It generates static HTML files that can be served without extra server-side support.pydoctor.readthedocs.io · read 5 Oct 2026
- Output organization
- PyDoctor generates one page per class, module, and package, and presents information using tables.pydoctor.readthedocs.io · read 5 Oct 2026
- Project background
- Pydoctor was written primarily to replace epydoc for the Twisted project, and Twisted remains a main driver of its development.pydoctor.readthedocs.io · read 5 Oct 2026
- Publishing
- The documentation gives examples for publishing generated API docs with GitHub Pages and Read the Docs.pydoctor.readthedocs.io · read 5 Oct 2026
