<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head> <title>Documenting Python</title> <META NAME="description" CONTENT="Documenting Python"> <META NAME="keywords" CONTENT="doc"> <META NAME="resource-type" CONTENT="document"> <META NAME="distribution" CONTENT="global"> <meta http-equiv="Content-Type" content="text/html; charset="> <link rel="STYLESHEET" href="doc.css"> <link rel="first" href="doc.html"> <link rel="contents" href="contents.html" title="Contents"> <LINK REL="next" href="contents.html"> </head> <body> <DIV CLASS="navigation"> <table align="center" width="100%" cellpadding="0" cellspacing="2"> <tr> <td><img src="../icons/blank.gif" border="0" height="32" alt="" width="32"></td> <td><A HREF="../index.html"><img src="../icons/up.gif" border="0" height="32" alt="Up One Level" width="32"></A></td> <td><A href="contents.html"><img src="../icons/next.gif" border="0" height="32" alt="Next Page" width="32"></A></td> <td align="center" width="100%">Documenting Python</td> <td><A href="contents.html"><img src="../icons/contents.gif" border="0" height="32" alt="Contents" width="32"></A></td> <td><img src="../icons/blank.gif" border="0" height="32" alt="" width="32"></td> <td><img src="../icons/blank.gif" border="0" height="32" alt="" width="32"></td> </tr></table> <b class="navlabel">Up:</b> <a class="sectref" HREF="../index.html">Python Documentation Index</A> <b class="navlabel">Next:</b> <a class="sectref" href="contents.html">Contents</A> <br><hr> </DIV> <!--End of Navigation Panel--> <P> <div class="titlepage"> <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.2</strong><br> <strong>December 21, 2001</strong></p> <p> </center> </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="logo,LaTeX">L<SUP><SMALL>A</SMALL></SUP>T<SMALL>E</SMALL>X</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. </DIV> <P> <P> <p><hr> <!--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="logo,LaTeX">L<SUP><SMALL>A</SMALL></SUP>T<SMALL>E</SMALL>X</SPAN> Primer</a> <UL> <LI><A href="node6.html">4.1 Syntax</a> <LI><A href="latex-syntax.html">4.2 Hierarchical Structure</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> </ul> <LI><A href="gui-markup.html">7 Graphical Interface Components</a> <LI><A href="tools.html">8 Processing Tools</a> <UL> <LI><A href="tools-external.html">8.1 External Tools</a> <LI><A href="tools-internal.html">8.2 Internal Tools</a> </ul> <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 CLASS="navigation"> <p><hr> <table align="center" width="100%" cellpadding="0" cellspacing="2"> <tr> <td><img src="../icons/blank.gif" border="0" height="32" alt="" width="32"></td> <td><A HREF="../index.html"><img src="../icons/up.gif" border="0" height="32" alt="Up One Level" width="32"></A></td> <td><A href="contents.html"><img src="../icons/next.gif" border="0" height="32" alt="Next Page" width="32"></A></td> <td align="center" width="100%">Documenting Python</td> <td><A href="contents.html"><img src="../icons/contents.gif" border="0" height="32" alt="Contents" width="32"></A></td> <td><img src="../icons/blank.gif" border="0" height="32" alt="" width="32"></td> <td><img src="../icons/blank.gif" border="0" height="32" alt="" width="32"></td> </tr></table> <b class="navlabel">Up:</b> <a class="sectref" HREF="../index.html">Python Documentation Index</A> <b class="navlabel">Next:</b> <a class="sectref" href="contents.html">Contents</A> <hr> <span class="release-info">Release 2.2, documentation updated on December 21, 2001.</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>
