How to generate python documentation.

Posted on Tue 27 August 2019 in Programming

It's been well known that one of the best document generator for python is "sphinx".

Sphinx is a tool that translate a set of "reStructuredText" source file into various output formats, automatically proceeding cross-references, indices, etc. That is, if you have s directory containing a bunch of reST-formatted documents (and possibly subdirectories of docs in there as well), Sphinx can generate a nicely-orgaized arrangement of HTML files (in some other directory) for easy browsing and navigation. But from the same source, it canals generate a PDF file using Latex.

Feel free to have a look and study from its official web: Shinx Generator