| 1 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| 2 | <html> |
| 3 | <head> |
| 4 | <link rel="STYLESHEET" href="doc.css" type='text/css' /> |
| 5 | <link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" /> |
| 6 | <link rel='start' href='../index.html' title='Python Documentation Index' /> |
| 7 | <link rel="first" href="doc.html" title='Documenting Python' /> |
| 8 | <link rel='contents' href='contents.html' title="Contents" /> |
| 9 | <link rel='last' href='about.html' title='About this document...' /> |
| 10 | <link rel='help' href='about.html' title='About this document...' /> |
| 11 | <link rel="next" href="contents.html" /> |
| 12 | <meta name='aesop' content='information' /> |
| 13 | <title>Documenting Python</title> |
| 14 | </head> |
| 15 | <body> |
| 16 | <DIV CLASS="navigation"> |
| 17 | <div id='top-navigation-panel' xml:id='top-navigation-panel'> |
| 18 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> |
| 19 | <tr> |
| 20 | <td class='online-navigation'><img src='../icons/previous.png' |
| 21 | border='0' height='32' alt='Previous Page' width='32' /></td> |
| 22 | <td class='online-navigation'><a rel="parent" title="Python Documentation Index" |
| 23 | href="../index.html"><img src='../icons/up.png' |
| 24 | border='0' height='32' alt='Up One Level' width='32' /></A></td> |
| 25 | <td class='online-navigation'><a rel="next" title="Contents" |
| 26 | href="contents.html"><img src='../icons/next.png' |
| 27 | border='0' height='32' alt='Next Page' width='32' /></A></td> |
| 28 | <td align="center" width="100%">Documenting Python</td> |
| 29 | <td class='online-navigation'><a rel="contents" title="Table of Contents" |
| 30 | href="contents.html"><img src='../icons/contents.png' |
| 31 | border='0' height='32' alt='Contents' width='32' /></A></td> |
| 32 | <td class='online-navigation'><img src='../icons/blank.png' |
| 33 | border='0' height='32' alt='' width='32' /></td> |
| 34 | <td class='online-navigation'><img src='../icons/blank.png' |
| 35 | border='0' height='32' alt='' width='32' /></td> |
| 36 | </tr></table> |
| 37 | <div class='online-navigation'> |
| 38 | <b class="navlabel">Up:</b> |
| 39 | <a class="sectref" rel="parent" href="../index.html">Python Documentation Index</A> |
| 40 | <b class="navlabel">Next:</b> |
| 41 | <a class="sectref" rel="next" href="contents.html">Contents</A> |
| 42 | </div> |
| 43 | <hr /></div> |
| 44 | </DIV> |
| 45 | <!--End of Navigation Panel--> |
| 46 | |
| 47 | <P> |
| 48 | |
| 49 | <link rel='up' href='../index.html' title='Python Documentation Index' /> |
| 50 | <div class="titlepage"> |
| 51 | <div class='center'> |
| 52 | <h1>Documenting Python</h1> |
| 53 | <p><b><font size="+2">Fred L. Drake, Jr.</font></b></p> |
| 54 | <p> |
| 55 | PythonLabs |
| 56 | <BR> |
| 57 | Email: <span class="email">fdrake@acm.org</span> |
| 58 | </p> |
| 59 | <p><strong>Release 2.4.2</strong><br /> |
| 60 | <strong>28 September 2005</strong></p> |
| 61 | <p></p> |
| 62 | </div> |
| 63 | </div> |
| 64 | |
| 65 | <P> |
| 66 | |
| 67 | <H3>Abstract:</H3> |
| 68 | <DIV CLASS="ABSTRACT"> |
| 69 | |
| 70 | The Python language has a substantial body of |
| 71 | documentation, much of it contributed by various authors. The markup |
| 72 | used for the Python documentation is based on <span class="LaTeX">LaTeX</span> and requires a |
| 73 | significant set of macros written specifically for documenting Python. |
| 74 | This document describes the macros introduced to support Python |
| 75 | documentation and how they should be used to support a wide range of |
| 76 | output formats. |
| 77 | |
| 78 | <P> |
| 79 | This document describes the document classes and special markup used |
| 80 | in the Python documentation. Authors may use this guide, in |
| 81 | conjunction with the template files provided with the |
| 82 | distribution, to create or maintain whole documents or sections. |
| 83 | |
| 84 | <P> |
| 85 | If you're interested in contributing to Python's documentation, |
| 86 | there's no need to learn <span class="LaTeX">LaTeX</span> if you're not so inclined; plain |
| 87 | text contributions are more than welcome as well. |
| 88 | </DIV> |
| 89 | <P> |
| 90 | |
| 91 | <P> |
| 92 | |
| 93 | <p><br /></p><hr class='online-navigation' /> |
| 94 | <div class='online-navigation'> |
| 95 | <!--Table of Child-Links--> |
| 96 | <A NAME="CHILD_LINKS"></a> |
| 97 | |
| 98 | <UL CLASS="ChildLinks"> |
| 99 | <LI><A href="contents.html">Contents</a> |
| 100 | <LI><A href="intro.html">1 Introduction</a> |
| 101 | <LI><A href="directories.html">2 Directory Structure</a> |
| 102 | <LI><A href="style-guide.html">3 Style Guide</a> |
| 103 | <LI><A href="latex-primer.html">4 <span class="LaTeX">LaTeX</span> Primer</a> |
| 104 | <UL> |
| 105 | <LI><A href="latex-syntax.html">4.1 Syntax</a> |
| 106 | <LI><A href="latex-structure.html">4.2 Hierarchical Structure</a> |
| 107 | <LI><A href="latex-environments.html">4.3 Common Environments</a> |
| 108 | </ul> |
| 109 | <LI><A href="classes.html">5 Document Classes</a> |
| 110 | <LI><A href="special-constructs.html">6 Special Markup Constructs</a> |
| 111 | <UL> |
| 112 | <LI><A href="preamble-info.html">6.1 Markup for the Preamble</a> |
| 113 | <LI><A href="meta-info.html">6.2 Meta-information Markup</a> |
| 114 | <LI><A href="info-units.html">6.3 Information Units</a> |
| 115 | <LI><A href="showing-examples.html">6.4 Showing Code Examples</a> |
| 116 | <LI><A href="inline-markup.html">6.5 Inline Markup</a> |
| 117 | <LI><A href="misc-text-markup.html">6.6 Miscellaneous Text Markup</a> |
| 118 | <LI><A href="module-markup.html">6.7 Module-specific Markup</a> |
| 119 | <LI><A href="library-markup.html">6.8 Library-level Markup</a> |
| 120 | <LI><A href="table-markup.html">6.9 Table Markup</a> |
| 121 | <LI><A href="references.html">6.10 Reference List Markup</a> |
| 122 | <LI><A href="indexing.html">6.11 Index-generating Markup</a> |
| 123 | <LI><A href="grammar-displays.html">6.12 Grammar Production Displays</a> |
| 124 | <LI><A href="gui-markup.html">6.13 Graphical Interface Components</a> |
| 125 | </ul> |
| 126 | <LI><A href="tools.html">7 Processing Tools</a> |
| 127 | <UL> |
| 128 | <LI><A href="tools-external.html">7.1 External Tools</a> |
| 129 | <LI><A href="tools-internal.html">7.2 Internal Tools</a> |
| 130 | <LI><A href="cygwin.html">7.3 Working on Cygwin</a> |
| 131 | </ul> |
| 132 | <LI><A href="graphics.html">8 Including Graphics</a> |
| 133 | <LI><A href="futures.html">9 Future Directions</a> |
| 134 | <UL> |
| 135 | <LI><A href="structured.html">9.1 Structured Documentation</a> |
| 136 | <LI><A href="discussion.html">9.2 Discussion Forums</a> |
| 137 | </ul> |
| 138 | <LI><A href="about.html">About this document ...</a> |
| 139 | </ul> |
| 140 | <!--End of Table of Child-Links--> |
| 141 | </div> |
| 142 | |
| 143 | <DIV CLASS="navigation"> |
| 144 | <div class='online-navigation'> |
| 145 | <p></p><hr /> |
| 146 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> |
| 147 | <tr> |
| 148 | <td class='online-navigation'><img src='../icons/previous.png' |
| 149 | border='0' height='32' alt='Previous Page' width='32' /></td> |
| 150 | <td class='online-navigation'><a rel="parent" title="Python Documentation Index" |
| 151 | href="../index.html"><img src='../icons/up.png' |
| 152 | border='0' height='32' alt='Up One Level' width='32' /></A></td> |
| 153 | <td class='online-navigation'><a rel="next" title="Contents" |
| 154 | href="contents.html"><img src='../icons/next.png' |
| 155 | border='0' height='32' alt='Next Page' width='32' /></A></td> |
| 156 | <td align="center" width="100%">Documenting Python</td> |
| 157 | <td class='online-navigation'><a rel="contents" title="Table of Contents" |
| 158 | href="contents.html"><img src='../icons/contents.png' |
| 159 | border='0' height='32' alt='Contents' width='32' /></A></td> |
| 160 | <td class='online-navigation'><img src='../icons/blank.png' |
| 161 | border='0' height='32' alt='' width='32' /></td> |
| 162 | <td class='online-navigation'><img src='../icons/blank.png' |
| 163 | border='0' height='32' alt='' width='32' /></td> |
| 164 | </tr></table> |
| 165 | <div class='online-navigation'> |
| 166 | <b class="navlabel">Up:</b> |
| 167 | <a class="sectref" rel="parent" href="../index.html">Python Documentation Index</A> |
| 168 | <b class="navlabel">Next:</b> |
| 169 | <a class="sectref" rel="next" href="contents.html">Contents</A> |
| 170 | </div> |
| 171 | </div> |
| 172 | <hr /> |
| 173 | <span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span> |
| 174 | </DIV> |
| 175 | <!--End of Navigation Panel--> |
| 176 | <ADDRESS> |
| 177 | See <i><a href="about.html">About this document...</a></i> for information on suggesting changes. |
| 178 | </ADDRESS> |
| 179 | </BODY> |
| 180 | </HTML> |