sam-t2/devtools/amd64/html/python/doc/doc.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="doc.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index' />
<link rel="first" href="doc.html" title='Documenting Python' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="contents.html" />
<meta name='aesop' content='information' />
<title>Documenting Python</title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></td>
<td class='online-navigation'><a rel="parent" title="Python Documentation Index"
  href="../index.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="Contents"
  href="contents.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Documenting Python</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><img src='../icons/blank.png'
  border='0' height='32'  alt='' width='32' /></td>
<td class='online-navigation'><img src='../icons/blank.png'
  border='0' height='32'  alt='' width='32' /></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="../index.html">Python Documentation Index</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="contents.html">Contents</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<P>

<link rel='up' href='../index.html' title='Python Documentation Index' />
<div class="titlepage">
<div class='center'>
<h1>Documenting Python</h1>
<p><b><font size="+2">Fred L. Drake, Jr.</font></b></p>
<p>
        PythonLabs
<BR>
Email: <span class="email">fdrake@acm.org</span>
</p>
<p><strong>Release 2.4.2</strong><br />
<strong>28 September 2005</strong></p>
<p></p>
</div>
</div>

<P>

<H3>Abstract:</H3>
<DIV CLASS="ABSTRACT">

The Python language has a substantial body of
documentation, much of it contributed by various authors.  The markup
used for the Python documentation is based on <span class="LaTeX">LaTeX</span> and requires a
significant set of macros written specifically for documenting Python.
This document describes the macros introduced to support Python
documentation and how they should be used to support a wide range of
output formats.

<P>
This document describes the document classes and special markup used
in the Python documentation.  Authors may use this guide, in
conjunction with the template files provided with the
distribution, to create or maintain whole documents or sections.

<P>
If you're interested in contributing to Python's documentation,
there's no need to learn <span class="LaTeX">LaTeX</span> if you're not so inclined; plain
text contributions are more than welcome as well.
</DIV>
<P>

<P>

<p><br /></p><hr class='online-navigation' />
<div class='online-navigation'>
<!--Table of Child-Links-->
<A NAME="CHILD_LINKS"></a>

<UL CLASS="ChildLinks">
<LI><A href="contents.html">Contents</a>
<LI><A href="intro.html">1 Introduction</a>
<LI><A href="directories.html">2 Directory Structure</a>
<LI><A href="style-guide.html">3 Style Guide</a>
<LI><A href="latex-primer.html">4 <span class="LaTeX">LaTeX</span> Primer</a>
<UL>
<LI><A href="latex-syntax.html">4.1 Syntax</a>
<LI><A href="latex-structure.html">4.2 Hierarchical Structure</a>
<LI><A href="latex-environments.html">4.3 Common Environments</a>
</ul>
<LI><A href="classes.html">5 Document Classes</a>
<LI><A href="special-constructs.html">6 Special Markup Constructs</a>
<UL>
<LI><A href="preamble-info.html">6.1 Markup for the Preamble</a>
<LI><A href="meta-info.html">6.2 Meta-information Markup</a>
<LI><A href="info-units.html">6.3 Information Units</a>
<LI><A href="showing-examples.html">6.4 Showing Code Examples</a>
<LI><A href="inline-markup.html">6.5 Inline Markup</a>
<LI><A href="misc-text-markup.html">6.6 Miscellaneous Text Markup</a>
<LI><A href="module-markup.html">6.7 Module-specific Markup</a>
<LI><A href="library-markup.html">6.8 Library-level Markup</a>
<LI><A href="table-markup.html">6.9 Table Markup</a>
<LI><A href="references.html">6.10 Reference List Markup</a>
<LI><A href="indexing.html">6.11 Index-generating Markup</a>
<LI><A href="grammar-displays.html">6.12 Grammar Production Displays</a>
<LI><A href="gui-markup.html">6.13 Graphical Interface Components</a>
</ul>
<LI><A href="tools.html">7 Processing Tools</a>
<UL>
<LI><A href="tools-external.html">7.1 External Tools</a>
<LI><A href="tools-internal.html">7.2 Internal Tools</a>
<LI><A href="cygwin.html">7.3 Working on Cygwin</a>
</ul>
<LI><A href="graphics.html">8 Including Graphics</a>
<LI><A href="futures.html">9 Future Directions</a>
<UL>
<LI><A href="structured.html">9.1 Structured Documentation</a>
<LI><A href="discussion.html">9.2 Discussion Forums</a>
</ul>
<LI><A href="about.html">About this document ...</a>
</ul>
<!--End of Table of Child-Links-->
</div>

<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></td>
<td class='online-navigation'><a rel="parent" title="Python Documentation Index"
  href="../index.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="Contents"
  href="contents.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Documenting Python</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><img src='../icons/blank.png'
  border='0' height='32'  alt='' width='32' /></td>
<td class='online-navigation'><img src='../icons/blank.png'
  border='0' height='32'  alt='' width='32' /></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="../index.html">Python Documentation Index</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="contents.html">Contents</A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
</DIV>
<!--End of Navigation Panel-->
<ADDRESS>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</ADDRESS>
</BODY>
</HTML>