PyDoctor
pydoctor.readthedocs.io
- Free plan
- Windows
- macOS
- Linux
7.4 Club score Visit pydoctor.readthedocs.io
What the maker publishes
- API pages
- Pydoctor generates a page for each class, module, and package, and presents information using tables. source
- Best fit
- The FAQ describes PyDoctor as probably best suited to documenting libraries with some degree of internal subclassing. source
- Configuration
- Pydoctor supports configuration through pydoctor.ini, pyproject.toml, and setup.cfg files. source
- Customization
- The CLI provides options for themes, custom HTML templates, and which API objects to document. source
- Docstring formats
- Supported docstring formats include epytext, reStructuredText, Google style, NumPy style, and plaintext. source
- Docstring formats
- It supports epytext, reStructuredText, Google-style, NumPy-style, and plain text docstrings. source
- Generated output
- PyDoctor generates static HTML pages that need no additional server-side support. source
- Imports and inheritance
- It resolves imports and computes inheritance hierarchies. source
- Inheritance and imports
- The tool works to resolve imports and calculate inheritance hierarchies. source
- Installation
- The documentation gives installation instructions through PyPI with pip and on Debian derivatives with apt. source
- Intended users
- The documentation says pydoctor is probably best suited to documenting libraries with some degree of internal subclassing. source
- Interface support
- It supports zope.interface and can show which classes implement which interfaces, and vice versa. source
- Maintainer context
- The FAQ says PyDoctor was written for the Twisted project, whose needs remain the main driving force for its development. source
- Notable limitation
- Pydoctor cannot infer types for computed values, so those need annotations for the type to appear in the generated documentation. source
- Notable Python version limit
- The project changelog says Python 3.8 support was dropped in version 25.4.0. source
- Output
- It generates static HTML files that can be served without extra server-side support. source
- Output organization
- PyDoctor generates one page per class, module, and package, and presents information using tables. source
- Project background
- Pydoctor was written primarily to replace epydoc for the Twisted project, and Twisted remains a main driver of its development. source
- Publishing
- The documentation gives examples for publishing generated API docs with GitHub Pages and Read the Docs. source
- Purpose
- Pydoctor is a standalone API documentation generator that analyzes Python source code statically. source
- Purpose
- PyDoctor is a standalone API documentation generator that uses static analysis of Python source code. source
- Security policy
- The project says it follows Twisted’s security policy and directs security reports to GitHub Security Advisories. source
- Sphinx integration
- Sphinx object inventories support cross-linking between pydoctor-generated API documentation and Sphinx documentation. source
- Sphinx integration
- The FAQ says Sphinx narrative documentation can link to API documentation formatted by PyDoctor. source
Checked against the maker's pages on 5 Oct 2026.