Jump to content

Pydoc

From Wikipedia, the free encyclopedia
This is an old revision of this page, as edited by Citation bot (talk | contribs) at 14:53, 4 March 2022 (Add: title. Changed bare reference to CS1/2. | Use this bot. Report bugs. | Suggested by BrownHairedGirl | Linked from User:BrownHairedGirl/Articles_with_bare_links | #UCB_webform_linked 604/2846). The present address (URL) is a permanent link to this revision, which may differ significantly from the current revision.

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. ^ 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".
Retrieved from "https://en.wikipedia.org/w/index.php?title=Pydoc&oldid=1075212494"