Pydoc

Pydoc is the standard documentation module for the programming language Python. Similar to the functionality of Perldoc within Perl and Javadoc within Java, Pydoc allows Python programmers to access Python's documentation help files, generate text and HTML pages with documentation specifics, and find the appropriate module for a particular job.[1]

Pydoc can be accessed from a module-specific GUI,[2] from within the Python interpreter, or from a command line shell.[1][3]

Developed by Ka-Ping Yee,[4][5] it is included by default in all versions of Python since Python 2.1 and is available for download for 1.5.2, 1.6, and 2.0.[3]

Pydoc is used to extract documentation from the source code itself. More comprehensive documentation is generated from external reStructuredText documents using the Sphinx documentation system.

See also

References
  1. Pydoc. Accessed 11/27/2010
  2. Using Pydoc. Accessed 11/27/2010
  3. Charming Python: pydoc and distutils modules. Accessed 01/01/2012
  4. http://zesty.ca/cv.html
  5. https://www.python.org/dev/peps/pep-0256/
This article is issued from Wikipedia. The text is licensed under Creative Commons - Attribution - Sharealike. Additional terms may apply for the media files.