I will attempt here to compare the top Python documentation tools using publicly available information. The goal is to identify which tool will be best for generating HTML from the docstrings within the source code. Criteria include but are not limited to:
- Visual appeal and ease-of-use (where case studies and/or screenshots are available)
- Potential dependency fragility, most importantly which versions of Python
- Community size/engagement and availability of tool support
- Run-time introspection vs static analysis (important only if parts of the software interface are dynamically generated)
I started by looking at the list of tools here: https://wiki.python.org/moin/DocumentationTools
The tools currently supported and/or in active development are:
- sphinx — http://www.sphinx-doc.org/en/master/index.html
- pdoc — https://github.com/BurntSushi/pdoc
- pydoctor — https://github.com/twisted/pydoctor
- Doxygen — http://www.stack.nl/~dimitri/doxygen/index.html
By far the most recommended and comprehensive documentation generator. It supports reStructu