Commit | Line | Data |
---|---|---|
86530b38 AT |
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="cygwin.html" /> | |
12 | <link rel="prev" href="tools-external.html" /> | |
13 | <link rel="parent" href="tools.html" /> | |
14 | <link rel="next" href="cygwin.html" /> | |
15 | <meta name='aesop' content='information' /> | |
16 | <title>7.2 Internal 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.1 External Tools" | |
24 | href="tools-external.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.3 Working on Cygwin" | |
30 | href="cygwin.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-external.html">7.1 External 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="cygwin.html">7.3 Working on Cygwin</A> | |
48 | </div> | |
49 | <hr /></div> | |
50 | </DIV> | |
51 | <!--End of Navigation Panel--> | |
52 | ||
53 | <H2><A NAME="SECTION000820000000000000000"></A><A NAME="tools-internal"></A> | |
54 | <BR> | |
55 | 7.2 Internal Tools | |
56 | </H2> | |
57 | ||
58 | <P> | |
59 | This section describes the various scripts that are used to | |
60 | implement various stages of document processing or to orchestrate | |
61 | entire build sequences. Most of these tools are only useful | |
62 | in the context of building the standard documentation, but some | |
63 | are more general. | |
64 | ||
65 | <P> | |
66 | <DL> | |
67 | <DT><STRONG><b class="program">mkhowto</b></STRONG></DT> | |
68 | <DD>This is the primary script used to format third-party | |
69 | documents. It contains all the logic needed to ``get it | |
70 | right.'' The proper way to use this script is to make a | |
71 | symbolic link to it or run it in place; the actual script file | |
72 | must be stored as part of the documentation source tree, | |
73 | though it may be used to format documents outside the tree. | |
74 | Use <b class="program">mkhowto</b> <b class="programopt">--help</b> for a list of | |
75 | command line options. | |
76 | ||
77 | <P> | |
78 | <b class="program">mkhowto</b> can be used for both <code>howto</code> and | |
79 | <code>manual</code> class documents. It is usually a good idea to | |
80 | always use the latest version of this tool rather than a | |
81 | version from an older source release of Python. It can be | |
82 | used to generate DVI, HTML, PDF, PostScript, and plain text | |
83 | documents. The GNU info and iSilo formats will be supported | |
84 | by this script in some future version. | |
85 | ||
86 | <P> | |
87 | Use the <b class="programopt">--help</b> option on this script's command | |
88 | line to get a summary of options for this script. | |
89 | ||
90 | <P> | |
91 | XXX Need more here. | |
92 | ||
93 | </DD> | |
94 | </DL> | |
95 | ||
96 | <P> | |
97 | ||
98 | <DIV CLASS="navigation"> | |
99 | <div class='online-navigation'> | |
100 | <p></p><hr /> | |
101 | <table align="center" width="100%" cellpadding="0" cellspacing="2"> | |
102 | <tr> | |
103 | <td class='online-navigation'><a rel="prev" title="7.1 External Tools" | |
104 | href="tools-external.html"><img src='../icons/previous.png' | |
105 | border='0' height='32' alt='Previous Page' width='32' /></A></td> | |
106 | <td class='online-navigation'><a rel="parent" title="7 Processing Tools" | |
107 | href="tools.html"><img src='../icons/up.png' | |
108 | border='0' height='32' alt='Up One Level' width='32' /></A></td> | |
109 | <td class='online-navigation'><a rel="next" title="7.3 Working on Cygwin" | |
110 | href="cygwin.html"><img src='../icons/next.png' | |
111 | border='0' height='32' alt='Next Page' width='32' /></A></td> | |
112 | <td align="center" width="100%">Documenting Python</td> | |
113 | <td class='online-navigation'><a rel="contents" title="Table of Contents" | |
114 | href="contents.html"><img src='../icons/contents.png' | |
115 | border='0' height='32' alt='Contents' width='32' /></A></td> | |
116 | <td class='online-navigation'><img src='../icons/blank.png' | |
117 | border='0' height='32' alt='' width='32' /></td> | |
118 | <td class='online-navigation'><img src='../icons/blank.png' | |
119 | border='0' height='32' alt='' width='32' /></td> | |
120 | </tr></table> | |
121 | <div class='online-navigation'> | |
122 | <b class="navlabel">Previous:</b> | |
123 | <a class="sectref" rel="prev" href="tools-external.html">7.1 External Tools</A> | |
124 | <b class="navlabel">Up:</b> | |
125 | <a class="sectref" rel="parent" href="tools.html">7 Processing Tools</A> | |
126 | <b class="navlabel">Next:</b> | |
127 | <a class="sectref" rel="next" href="cygwin.html">7.3 Working on Cygwin</A> | |
128 | </div> | |
129 | </div> | |
130 | <hr /> | |
131 | <span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span> | |
132 | </DIV> | |
133 | <!--End of Navigation Panel--> | |
134 | <ADDRESS> | |
135 | See <i><a href="about.html">About this document...</a></i> for information on suggesting changes. | |
136 | </ADDRESS> | |
137 | </BODY> | |
138 | </HTML> |