Pydoc модуль документации для Python

• pydoc — Documentation generator and online help system

Python предлагает механизм документирования кода pydoc. В начало каждого модуля, класса, функции вставляется строка документации, что используется современными IDE (например, Eclipse IDE).

Документацию по pydoc, можно вывести командой:

$ pydoc pydoc
Help on module pydoc:
 
NAME
    pydoc - Generate Python documentation in HTML or text for interactive use.
 
FILE
    /usr/lib/python2.6/pydoc.py
 
MODULE DOCS
    /usr/share/doc/python2.6/html/library/pydoc.html
...

Для просмотра документации по модулям Python pydoc можно запустить в виде WEB - сервера:

$ pydoc -p 8081
pydoc server ready at http://localhost:8081/

Чтобы сгенерировать HTML-документацию для модуля, в виде module_name.html, необходимо выполнить:

$ pydoc -w module_name