Pydoc

Source: Wikipedia, the free encyclopedia.

Pydoc is the standard documentation module for the

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

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. ^ a b Pydoc. Accessed 11/27/2010
  2. ^ Using Pydoc. Accessed 11/27/2010
  3. ^ a b Charming Python: pydoc and distutils modules. Accessed 01/01/2012
  4. ^ "Ka-Ping Yee: Curriculum Vitae".
  5. ^ "PEP 256 -- Docstring Processing System Framework".

External links

This page is based on the copyrighted Wikipedia article: Pydoc. Articles is available under the CC BY-SA 3.0 license; additional terms may apply.Privacy Policy