Add to Chrome
Add to Edge
Add to Firefox
Add to Opera
Add to Brave
Add to SafariWhen comparing Sphinx vs PyDoctor, the Slant community recommends Sphinx for most people. In the question“What are the best Python documentation generators?” Sphinx is ranked 1st while PyDoctor is ranked 3rd. The most important reason people chose Sphinx is:
It supports reStructuredText in docstrings and produces an HTML output with a clean visual style. Automatic links for functions, classes, citations and glossary terms. It has a hierarchical structure and automatic indices.
Specs
Question Ranking
Pros
Pro Output comes with different format
It supports reStructuredText in docstrings and produces an HTML output with a clean visual style. Automatic links for functions, classes, citations and glossary terms. It has a hierarchical structure and automatic indices.
Pro Good documentation and lots of examples listed on their website
Sphinx documentation is well written and very detailed. From beginner to advanced user can easily navigate through their navigation.
Pro Created for improvement
Pydoctor was created to improve more from Epydoc. So it is even more better that Epydoc. For the purposes of the Twisted project as epydoc has difficulties with zope.interface. Puts a fair bit of effort into resolving imports and computing inheritance hierarchies and, as it aims at documenting Twisted, knows about zope.interface's declaration API and can present information about which classes implement which interface, and vice versa.
Pro Output can be pass to Sphinx
PyDoctor can pass object model to Sphinx to output style same as Sphinx. So from Pydoctor you could still pass the object model to Sphinx if you still prefer Sphinx look.
Pro Outstanding clean look
Pydoctor has more neat look compared to other documentation generator.
Cons
Con Too complex for a beginner
It requires a bit of configuration. It introduces using Makefile. It can also be run using a quickstart script but also requires a bit of steps to begin.
Con Poor documentation and small size of community
Documentation is little and there isn't too much about Pydoctor references. Unlike Sphinx or any other documentation generators.
Con Works on Python 2 only
