<!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>Documenting Python — Python v2.7 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', 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> <link rel="search" type="application/opensearchdescription+xml" title="Search within Python v2.7 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 v2.7 documentation" href="../index.html" /> <link rel="next" title="1. Introduction" href="intro.html" /> <link rel="prev" title="Installing Python Modules" href="../install/index.html" /> <link rel="shortcut icon" type="image/png" href="../_static/py.png" /> </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="intro.html" title="1. Introduction" accesskey="N">next</a> |</li> <li class="right" > <a href="../install/index.html" title="Installing Python Modules" accesskey="P">previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="../index.html">Python v2.7 documentation</a> »</li> </ul> </div> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body"> <div class="section" id="documenting-python"> <span id="documenting-index"></span><h1>Documenting Python<a class="headerlink" href="#documenting-python" title="Permalink to this headline">ΒΆ</a></h1> <p>The Python language has a substantial body of documentation, much of it contributed by various authors. The markup used for the Python documentation is <a class="reference external" href="http://docutils.sf.net/rst.html">reStructuredText</a>, developed by the <a class="reference external" href="http://docutils.sf.net/">docutils</a> project, amended by custom directives and using a toolset named <a class="reference external" href="http://sphinx.pocoo.org/">Sphinx</a> to postprocess the HTML output.</p> <p>This document describes the style guide for our documentation as well as the custom reStructuredText markup introduced by Sphinx to support Python documentation and how it should be used.</p> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">If you’re interested in contributing to Python’s documentation, there’s no need to write reStructuredText if you’re not so inclined; plain text contributions are more than welcome as well. Send an e-mail to <a class="reference external" href="mailto:docs%40python.org">docs<span>@</span>python<span>.</span>org</a> or open an issue on the <a class="reference internal" href="../bugs.html#reporting-bugs"><em>tracker</em></a>.</p> </div> <div class="toctree-wrapper compound"> <ul> <li class="toctree-l1"><a class="reference internal" href="intro.html">1. Introduction</a></li> <li class="toctree-l1"><a class="reference internal" href="style.html">2. Style Guide</a></li> <li class="toctree-l1"><a class="reference internal" href="rest.html">3. reStructuredText Primer</a></li> <li class="toctree-l1"><a class="reference internal" href="markup.html">4. Additional Markup Constructs</a></li> <li class="toctree-l1"><a class="reference internal" href="fromlatex.html">5. Differences to the LaTeX markup</a></li> <li class="toctree-l1"><a class="reference internal" href="building.html">6. Building the documentation</a></li> </ul> </div> </div> </div> </div> </div> <div class="sphinxsidebar"> <div class="sphinxsidebarwrapper"> <h4>Previous topic</h4> <p class="topless"><a href="../install/index.html" title="previous chapter">Installing Python Modules</a></p> <h4>Next topic</h4> <p class="topless"><a href="intro.html" title="next chapter">1. Introduction</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/documenting/index.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" size="18" /> <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="intro.html" title="1. Introduction" >next</a> |</li> <li class="right" > <a href="../install/index.html" title="Installing Python Modules" >previous</a> |</li> <li><img src="../_static/py.png" alt="" style="vertical-align: middle; margin-top: -1px"/></li> <li><a href="../index.html">Python v2.7 documentation</a> »</li> </ul> </div> <div class="footer"> © <a href="../copyright.html">Copyright</a> 1990-2010, 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 Aug 09, 2010. <a href="../bugs.html">Found a bug</a>? <br /> Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0b2. </div> </body> </html>