How to generate documentation using Pydoc

Question

I need to generate documentation from comments using pydoc. What are the basic steps to do that?

Answer 1

Alternatively, if you want a simple text file instead of HTML, you can redirect the console output to a file with this simple command:

$ pydoc myproject > helpfile.txt

This file can be printed or uploaded to Github without too much additional effort.