Side by side
MkDocs vs PyDoctor
Both stand on documentation generators. Which one you can start free with, which one lets you read the code, and what each costs once you pay.
Free plan LinuxMacSelf-hosted+1
MkDocs provides a command-line workflow for turning Markdown project documentation into static sites with search and theme options. Users should account for its Python requirements and the code-execution risks of third-party themes and plugins.
Visit MkDocs Free plan LinuxMacWindows
PyDoctor provides static, configurable API documentation for Python projects, with inheritance, interface, and Sphinx-linking support. Its type-inference limitation and dropped Python 3.8 support are important compatibility considerations.
Visit PyDoctorThe facts
| MkDocs | PyDoctor | |
|---|---|---|
| Free plan | Yes | Yes |
| Open source | Not published | Not published |
| Runs on | Linux, Mac, Self-hosted, Windows | Linux, Mac, Windows |
| Lowest paid plan | Not published | Not published |
| Plans published | None | None |
| Maker | Not published | Not published |
| Website | mkdocs.org | pydoctor.readthedocs.io |
| On documentation generators | #15 of 37 | #19 of 37 |
MkDocs: what it does well
- Free and distributed under the BSD license
- Local preview reloads when documentation changes
- Generated site includes search with section links
- Static HTML can use multiple hosting providers
What to know first
- Requires a recent Python version and pip
- Third-party themes execute unsandboxed author code
- Plugins execute unsandboxed author code
PyDoctor: what it does well
- Free plan available
- Generates static HTML API pages
- Resolves imports and inheritance
- Supports several docstring formats
- Runs on Linux, macOS, and Windows
What to know first
- Computed values need type annotations
- Python 3.8 support was dropped
- Best suited to libraries with internal subclassing
Alternatives to MkDocs Alternatives to PyDoctor The whole list