| 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="tools-internal.html" /> |
| 12 | <link rel="prev" href="tools.html" /> |
| 13 | <link rel="parent" href="tools.html" /> |
| 14 | <link rel="next" href="tools-internal.html" /> |
| 15 | <meta name='aesop' content='information' /> |
| 16 | <title>7.1 External Tools </title> |
| 17 | </head> |
| 18 | <body> |
| 19 | <DIV CLASS="navigation"> |
| 20 | <div id='top-navigation-panel' xml:id='top-navigation-panel'> |
| 21 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> |
| 22 | <tr> |
| 23 | <td class='online-navigation'><a rel="prev" title="7 Processing Tools" |
| 24 | href="tools.html"><img src='../icons/previous.png' |
| 25 | border='0' height='32' alt='Previous Page' width='32' /></A></td> |
| 26 | <td class='online-navigation'><a rel="parent" title="7 Processing Tools" |
| 27 | href="tools.html"><img src='../icons/up.png' |
| 28 | border='0' height='32' alt='Up One Level' width='32' /></A></td> |
| 29 | <td class='online-navigation'><a rel="next" title="7.2 Internal Tools" |
| 30 | href="tools-internal.html"><img src='../icons/next.png' |
| 31 | border='0' height='32' alt='Next Page' width='32' /></A></td> |
| 32 | <td align="center" width="100%">Documenting Python</td> |
| 33 | <td class='online-navigation'><a rel="contents" title="Table of Contents" |
| 34 | href="contents.html"><img src='../icons/contents.png' |
| 35 | border='0' height='32' alt='Contents' width='32' /></A></td> |
| 36 | <td class='online-navigation'><img src='../icons/blank.png' |
| 37 | border='0' height='32' alt='' width='32' /></td> |
| 38 | <td class='online-navigation'><img src='../icons/blank.png' |
| 39 | border='0' height='32' alt='' width='32' /></td> |
| 40 | </tr></table> |
| 41 | <div class='online-navigation'> |
| 42 | <b class="navlabel">Previous:</b> |
| 43 | <a class="sectref" rel="prev" href="tools.html">7 Processing Tools</A> |
| 44 | <b class="navlabel">Up:</b> |
| 45 | <a class="sectref" rel="parent" href="tools.html">7 Processing Tools</A> |
| 46 | <b class="navlabel">Next:</b> |
| 47 | <a class="sectref" rel="next" href="tools-internal.html">7.2 Internal Tools</A> |
| 48 | </div> |
| 49 | <hr /></div> |
| 50 | </DIV> |
| 51 | <!--End of Navigation Panel--> |
| 52 | |
| 53 | <H2><A NAME="SECTION000810000000000000000"></A><A NAME="tools-external"></A> |
| 54 | <BR> |
| 55 | 7.1 External Tools |
| 56 | </H2> |
| 57 | |
| 58 | <P> |
| 59 | Many tools are needed to be able to process the Python |
| 60 | documentation if all supported formats are required. This |
| 61 | section lists the tools used and when each is required. Consult |
| 62 | the <span class="file">Doc/README</span> file to see if there are specific version |
| 63 | requirements for any of these. |
| 64 | |
| 65 | <P> |
| 66 | <DL> |
| 67 | <DT><STRONG><b class="program">dvips</b></STRONG></DT> |
| 68 | <DD>This program is a typical part of <span class="TeX">TeX</span> installations. It is |
| 69 | used to generate PostScript from the ``device independent'' |
| 70 | <span class="file">.dvi</span> files. It is needed for the conversion to |
| 71 | PostScript. |
| 72 | |
| 73 | <P> |
| 74 | </DD> |
| 75 | <DT><STRONG><b class="program">emacs</b></STRONG></DT> |
| 76 | <DD>Emacs is the kitchen sink of programmers' editors, and a damn |
| 77 | fine kitchen sink it is. It also comes with some of the |
| 78 | processing needed to support the proper menu structures for |
| 79 | Texinfo documents when an info conversion is desired. This is |
| 80 | needed for the info conversion. Using <b class="program">xemacs</b> |
| 81 | instead of FSF <b class="program">emacs</b> may lead to instability in the |
| 82 | conversion, but that's because nobody seems to maintain the |
| 83 | Emacs Texinfo code in a portable manner. |
| 84 | |
| 85 | <P> |
| 86 | </DD> |
| 87 | <DT><STRONG><b class="program">latex</b></STRONG></DT> |
| 88 | <DD><span class="LaTeX">LaTeX</span> is a large and extensible macro package by Leslie |
| 89 | Lamport, based on <span class="TeX">TeX</span>, a world-class typesetter by Donald |
| 90 | Knuth. It is used for the conversion to PostScript, and is |
| 91 | needed for the HTML conversion as well (<span class="LaTeX">LaTeX</span>2HTML requires |
| 92 | one of the intermediate files it creates). |
| 93 | |
| 94 | <P> |
| 95 | </DD> |
| 96 | <DT><STRONG><b class="program">latex2html</b></STRONG></DT> |
| 97 | <DD>Probably the longest Perl script anyone ever attempted to |
| 98 | maintain. This converts <span class="LaTeX">LaTeX</span> documents to HTML documents, |
| 99 | and does a pretty reasonable job. It is required for the |
| 100 | conversions to HTML and GNU info. |
| 101 | |
| 102 | <P> |
| 103 | </DD> |
| 104 | <DT><STRONG><b class="program">lynx</b></STRONG></DT> |
| 105 | <DD>This is a text-mode Web browser which includes an |
| 106 | HTML-to-plain text conversion. This is used to convert |
| 107 | <code>howto</code> documents to text. |
| 108 | |
| 109 | <P> |
| 110 | </DD> |
| 111 | <DT><STRONG><b class="program">make</b></STRONG></DT> |
| 112 | <DD>Just about any version should work for the standard documents, |
| 113 | but GNU <b class="program">make</b> is required for the experimental |
| 114 | processes in <span class="file">Doc/tools/sgmlconv/</span>, at least while |
| 115 | they're experimental. This is not required for running the |
| 116 | <b class="program">mkhowto</b> script. |
| 117 | |
| 118 | <P> |
| 119 | </DD> |
| 120 | <DT><STRONG><b class="program">makeindex</b></STRONG></DT> |
| 121 | <DD>This is a standard program for converting <span class="LaTeX">LaTeX</span> index data |
| 122 | to a formatted index; it should be included with all <span class="LaTeX">LaTeX</span> |
| 123 | installations. It is needed for the PDF and PostScript |
| 124 | conversions. |
| 125 | |
| 126 | <P> |
| 127 | </DD> |
| 128 | <DT><STRONG><b class="program">makeinfo</b></STRONG></DT> |
| 129 | <DD>GNU <b class="program">makeinfo</b> is used to convert Texinfo documents to |
| 130 | GNU info files. Since Texinfo is used as an intermediate |
| 131 | format in the info conversion, this program is needed in that |
| 132 | conversion. |
| 133 | |
| 134 | <P> |
| 135 | </DD> |
| 136 | <DT><STRONG><b class="program">pdflatex</b></STRONG></DT> |
| 137 | <DD>pdf<span class="TeX">TeX</span> is a relatively new variant of <span class="TeX">TeX</span>, and is used to |
| 138 | generate the PDF version of the manuals. It is typically |
| 139 | installed as part of most of the large <span class="TeX">TeX</span> distributions. |
| 140 | <b class="program">pdflatex</b> is pdf<span class="TeX">TeX</span> using the <span class="LaTeX">LaTeX</span> format. |
| 141 | |
| 142 | <P> |
| 143 | </DD> |
| 144 | <DT><STRONG><b class="program">perl</b></STRONG></DT> |
| 145 | <DD>Perl is required for <span class="LaTeX">LaTeX</span>2HTML and one of the scripts used |
| 146 | to post-process <span class="LaTeX">LaTeX</span>2HTML output, as well as the |
| 147 | HTML-to-Texinfo conversion. This is required for |
| 148 | the HTML and GNU info conversions. |
| 149 | |
| 150 | <P> |
| 151 | </DD> |
| 152 | <DT><STRONG><b class="program">python</b></STRONG></DT> |
| 153 | <DD>Python is used for many of the scripts in the |
| 154 | <span class="file">Doc/tools/</span> directory; it is required for all |
| 155 | conversions. This shouldn't be a problem if you're interested |
| 156 | in writing documentation for Python! |
| 157 | |
| 158 | </DD> |
| 159 | </DL> |
| 160 | |
| 161 | <P> |
| 162 | |
| 163 | <DIV CLASS="navigation"> |
| 164 | <div class='online-navigation'> |
| 165 | <p></p><hr /> |
| 166 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> |
| 167 | <tr> |
| 168 | <td class='online-navigation'><a rel="prev" title="7 Processing Tools" |
| 169 | href="tools.html"><img src='../icons/previous.png' |
| 170 | border='0' height='32' alt='Previous Page' width='32' /></A></td> |
| 171 | <td class='online-navigation'><a rel="parent" title="7 Processing Tools" |
| 172 | href="tools.html"><img src='../icons/up.png' |
| 173 | border='0' height='32' alt='Up One Level' width='32' /></A></td> |
| 174 | <td class='online-navigation'><a rel="next" title="7.2 Internal Tools" |
| 175 | href="tools-internal.html"><img src='../icons/next.png' |
| 176 | border='0' height='32' alt='Next Page' width='32' /></A></td> |
| 177 | <td align="center" width="100%">Documenting Python</td> |
| 178 | <td class='online-navigation'><a rel="contents" title="Table of Contents" |
| 179 | href="contents.html"><img src='../icons/contents.png' |
| 180 | border='0' height='32' alt='Contents' width='32' /></A></td> |
| 181 | <td class='online-navigation'><img src='../icons/blank.png' |
| 182 | border='0' height='32' alt='' width='32' /></td> |
| 183 | <td class='online-navigation'><img src='../icons/blank.png' |
| 184 | border='0' height='32' alt='' width='32' /></td> |
| 185 | </tr></table> |
| 186 | <div class='online-navigation'> |
| 187 | <b class="navlabel">Previous:</b> |
| 188 | <a class="sectref" rel="prev" href="tools.html">7 Processing Tools</A> |
| 189 | <b class="navlabel">Up:</b> |
| 190 | <a class="sectref" rel="parent" href="tools.html">7 Processing Tools</A> |
| 191 | <b class="navlabel">Next:</b> |
| 192 | <a class="sectref" rel="next" href="tools-internal.html">7.2 Internal Tools</A> |
| 193 | </div> |
| 194 | </div> |
| 195 | <hr /> |
| 196 | <span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span> |
| 197 | </DIV> |
| 198 | <!--End of Navigation Panel--> |
| 199 | <ADDRESS> |
| 200 | See <i><a href="about.html">About this document...</a></i> for information on suggesting changes. |
| 201 | </ADDRESS> |
| 202 | </BODY> |
| 203 | </HTML> |