Edit File: pydoc.html
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>25.1. pydoc — Documentation generator and online help system — Python 2.7.5 documentation</title> <link rel="stylesheet" href="../_static/default.css" type="text/css" /> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT: '../', VERSION: '2.7.5', COLLAPSE_INDEX: false, FILE_SUFFIX: '.html', HAS_SOURCE: true }; </script> <script type="text/javascript" src="../_static/jquery.js"></script> <script type="text/javascript" src="../_static/underscore.js"></script> <script type="text/javascript" src="../_static/doctools.js"></script> <script type="text/javascript" src="../_static/sidebar.js"></script> <link rel="search" type="application/opensearchdescription+xml" title="Search within Python 2.7.5 documentation" href="../_static/opensearch.xml"/> <link rel="author" title="About these documents" href="../about.html" /> <link rel="copyright" title="Copyright" href="../copyright.html" /> <link rel="top" title="Python 2.7.5 documentation" href="../index.html" /> <link rel="up" title="25. Development Tools" href="development.html" /> <link rel="next" title="25.2. doctest — Test interactive Python examples" href="doctest.html" /> <link rel="prev" title="25. Development Tools" href="development.html" /> <link rel="shortcut icon" type="image/png" href="../_static/py.png" /> <script type="text/javascript" src="../_static/copybutton.js"></script> </head> <body> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" accesskey="I">index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="doctest.html" title="25.2. doctest — Test interactive Python examples" accesskey="N">next</a> |</li> <li class="right" > <a href="development.html" title="25. Development Tools" accesskey="P">previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="http://www.python.org/">Python</a> »</li> <li> <a href="../index.html">Python 2.7.5 documentation</a> » </li> <li><a href="index.html" >The Python Standard Library</a> »</li> <li><a href="development.html" accesskey="U">25. Development Tools</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="module-pydoc"> <span id="pydoc-documentation-generator-and-online-help-system"></span><h1>25.1. <a class="reference internal" href="#module-pydoc" title="pydoc: Documentation generator and online help system."><tt class="xref py py-mod docutils literal"><span class="pre">pydoc</span></tt></a> — Documentation generator and online help system<a class="headerlink" href="#module-pydoc" title="Permalink to this headline">¶</a></h1> <p class="versionadded"> <span class="versionmodified">New in version 2.1.</span></p> <p id="index-0"><strong>Source code:</strong> <a class="reference external" href="http://hg.python.org/cpython/file/2.7/Lib/pydoc.py">Lib/pydoc.py</a></p> <hr class="docutils" /> <p>The <a class="reference internal" href="#module-pydoc" title="pydoc: Documentation generator and online help system."><tt class="xref py py-mod docutils literal"><span class="pre">pydoc</span></tt></a> module automatically generates documentation from Python modules. The documentation can be presented as pages of text on the console, served to a Web browser, or saved to HTML files.</p> <p>The built-in function <a class="reference internal" href="functions.html#help" title="help"><tt class="xref py py-func docutils literal"><span class="pre">help()</span></tt></a> invokes the online help system in the interactive interpreter, which uses <a class="reference internal" href="#module-pydoc" title="pydoc: Documentation generator and online help system."><tt class="xref py py-mod docutils literal"><span class="pre">pydoc</span></tt></a> to generate its documentation as text on the console. The same text documentation can also be viewed from outside the Python interpreter by running <strong class="program">pydoc</strong> as a script at the operating system’s command prompt. For example, running</p> <div class="highlight-python"><pre>pydoc sys</pre> </div> <p>at a shell prompt will display documentation on the <a class="reference internal" href="sys.html#module-sys" title="sys: Access system-specific parameters and functions."><tt class="xref py py-mod docutils literal"><span class="pre">sys</span></tt></a> module, in a style similar to the manual pages shown by the Unix <strong class="program">man</strong> command. The argument to <strong class="program">pydoc</strong> can be the name of a function, module, or package, or a dotted reference to a class, method, or function within a module or module in a package. If the argument to <strong class="program">pydoc</strong> looks like a path (that is, it contains the path separator for your operating system, such as a slash in Unix), and refers to an existing Python source file, then documentation is produced for that file.</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">In order to find objects and their documentation, <a class="reference internal" href="#module-pydoc" title="pydoc: Documentation generator and online help system."><tt class="xref py py-mod docutils literal"><span class="pre">pydoc</span></tt></a> imports the module(s) to be documented. Therefore, any code on module level will be executed on that occasion. Use an <tt class="docutils literal"><span class="pre">if</span> <span class="pre">__name__</span> <span class="pre">==</span> <span class="pre">'__main__':</span></tt> guard to only execute code when a file is invoked as a script and not just imported.</p> </div> <p>Specifying a <tt class="docutils literal"><span class="pre">-w</span></tt> flag before the argument will cause HTML documentation to be written out to a file in the current directory, instead of displaying text on the console.</p> <p>Specifying a <tt class="docutils literal"><span class="pre">-k</span></tt> flag before the argument will search the synopsis lines of all available modules for the keyword given as the argument, again in a manner similar to the Unix <strong class="program">man</strong> command. The synopsis line of a module is the first line of its documentation string.</p> <p>You can also use <strong class="program">pydoc</strong> to start an HTTP server on the local machine that will serve documentation to visiting Web browsers. <strong class="program">pydoc -p 1234</strong> will start a HTTP server on port 1234, allowing you to browse the documentation at <tt class="docutils literal"><span class="pre">http://localhost:1234/</span></tt> in your preferred Web browser. <strong class="program">pydoc -g</strong> will start the server and additionally bring up a small <a class="reference internal" href="tkinter.html#module-Tkinter" title="Tkinter: Interface to Tcl/Tk for graphical user interfaces"><tt class="xref py py-mod docutils literal"><span class="pre">Tkinter</span></tt></a>-based graphical interface to help you search for documentation pages.</p> <p>When <strong class="program">pydoc</strong> generates documentation, it uses the current environment and path to locate modules. Thus, invoking <strong class="program">pydoc spam</strong> documents precisely the version of the module you would get if you started the Python interpreter and typed <tt class="docutils literal"><span class="pre">import</span> <span class="pre">spam</span></tt>.</p> <p>Module docs for core modules are assumed to reside in <a class="reference external" href="http://docs.python.org/library/">http://docs.python.org/library/</a>. This can be overridden by setting the <span class="target" id="index-1"></span><tt class="xref std std-envvar docutils literal"><span class="pre">PYTHONDOCS</span></tt> environment variable to a different URL or to a local directory containing the Library Reference Manual pages.</p> </div> </div> </div> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h4>Previous topic</h4> <p class="topless"><a href="development.html" title="previous chapter">25. Development Tools</a></p> <h4>Next topic</h4> <p class="topless"><a href="doctest.html" title="next chapter">25.2. <tt class="docutils literal"><span class="pre">doctest</span></tt> — Test interactive Python examples</a></p> <h3>This Page</h3> <ul class="this-page-menu"> <li><a href="../bugs.html">Report a Bug</a></li> <li><a href="../_sources/library/pydoc.txt" rel="nofollow">Show Source</a></li> </ul> <div id="searchbox" style="display: none"> <h3>Quick search</h3> <form class="search" action="../search.html" method="get"> <input type="text" name="q" /> <input type="submit" value="Go" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> <p class="searchtip" style="font-size: 90%"> Enter search terms or a module, class or function name. </p> </div> <script type="text/javascript">$('#searchbox').show(0);</script> </div> </div> <div class="clearer"></div> </div> <div class="related"> <h3>Navigation</h3> <ul> <li class="right" style="margin-right: 10px"> <a href="../genindex.html" title="General Index" >index</a></li> <li class="right" > <a href="../py-modindex.html" title="Python Module Index" >modules</a> |</li> <li class="right" > <a href="doctest.html" title="25.2. doctest — Test interactive Python examples" >next</a> |</li> <li class="right" > <a href="development.html" title="25. Development Tools" >previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="http://www.python.org/">Python</a> »</li> <li> <a href="../index.html">Python 2.7.5 documentation</a> » </li> <li><a href="index.html" >The Python Standard Library</a> »</li> <li><a href="development.html" >25. Development Tools</a> »</li> </ul> </div> <div class="footer"> © <a href="../copyright.html">Copyright</a> 1990-2020, Python Software Foundation. <br /> The Python Software Foundation is a non-profit corporation. <a href="http://www.python.org/psf/donations/">Please donate.</a> <br /> Last updated on Oct 13, 2020. <a href="../bugs.html">Found a bug</a>? <br /> Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3. </div> </body> </html>