projects / OpenSPARC-T2-SAM / blame
? search:
summary | tags | clone url | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Initial commit of OpenSPARC T2 architecture model.
[OpenSPARC-T2-SAM] / sam-t2 / devtools / v8plus / html / python / doc / directories.html
CommitLineData
920dae64
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="style-guide.html" />
12<link rel="prev" href="intro.html" />
13<link rel="parent" href="doc.html" />
14<link rel="next" href="style-guide.html" />
15<meta name='aesop' content='information' />
16<title>2 Directory Structure </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="1 Introduction"
24 href="intro.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="Documenting Python"
27 href="doc.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="3 Style Guide"
30 href="style-guide.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="intro.html">1 Introduction</A>
44<b class="navlabel">Up:</b>
45<a class="sectref" rel="parent" href="doc.html">Documenting Python</A>
46<b class="navlabel">Next:</b>
47<a class="sectref" rel="next" href="style-guide.html">3 Style Guide</A>
48</div>
49<hr /></div>
50</DIV>
51<!--End of Navigation Panel-->
52
53<H1><A NAME="SECTION000300000000000000000"></A><A NAME="directories"></A>
54<BR>
552 Directory Structure
56</H1>
57
58<P>
59The source distribution for the standard Python documentation
60 contains a large number of directories. While third-party documents
61 do not need to be placed into this structure or need to be placed
62 within a similar structure, it can be helpful to know where to look
63 for examples and tools when developing new documents using the
64 Python documentation tools. This section describes this directory
65 structure.
66
67<P>
68The documentation sources are usually placed within the Python
69 source distribution as the top-level directory <span class="file">Doc/</span>, but
70 are not dependent on the Python source distribution in any way.
71
72<P>
73The <span class="file">Doc/</span> directory contains a few files and several
74 subdirectories. The files are mostly self-explanatory, including a
75 <span class="file">README</span> and a <span class="file">Makefile</span>. The directories fall into
76 three categories:
77
78<P>
79<dl class="definitions">
80 <dt><b><a id='l2h-1' xml:id='l2h-1'>Document Sources</a></b></dt>
81<dd>
82 The <span class="LaTeX">LaTeX</span> sources for each document are placed in a
83 separate directory. These directories are given short
84 names which vaguely indicate the document in each:
85
86<P>
87<div class="center"><table class="realtable">
88 <thead>
89 <tr>
90 <th class="left" >Directory</th>
91 <th class="left" >Document Title</th>
92 </tr>
93 </thead>
94 <tbody>
95 <tr><td class="left" valign="baseline"><tt class="file">api/</tt></td>
96 <td class="left" ><em class="citetitle"><a
97 href="../api/api.html"
98 title="The Python/C API"
99 >The Python/C API</a></em></td></tr>
100 <tr><td class="left" valign="baseline"><tt class="file">dist/</tt></td>
101 <td class="left" ><em class="citetitle"><a
102 href="../dist/dist.html"
103 title="Distributing Python Modules"
104 >Distributing Python Modules</a></em></td></tr>
105 <tr><td class="left" valign="baseline"><tt class="file">doc/</tt></td>
106 <td class="left" ><em class="citetitle"><a
107 href="../doc/doc.html"
108 title="Documenting Python"
109 >Documenting Python</a></em></td></tr>
110 <tr><td class="left" valign="baseline"><tt class="file">ext/</tt></td>
111 <td class="left" ><em class="citetitle"><a
112 href="../ext/ext.html"
113 title="Extending and Embedding the Python Interpreter"
114 >Extending and Embedding the Python Interpreter</a></em></td></tr>
115 <tr><td class="left" valign="baseline"><tt class="file">inst/</tt></td>
116 <td class="left" ><em class="citetitle"><a
117 href="../inst/inst.html"
118 title="Installing Python Modules"
119 >Installing Python Modules</a></em></td></tr>
120 <tr><td class="left" valign="baseline"><tt class="file">lib/</tt></td>
121 <td class="left" ><em class="citetitle"><a
122 href="../lib/lib.html"
123 title="Python Library Reference"
124 >Python Library Reference</a></em></td></tr>
125 <tr><td class="left" valign="baseline"><tt class="file">mac/</tt></td>
126 <td class="left" ><em class="citetitle"><a
127 href="../mac/mac.html"
128 title="Macintosh Module Reference"
129 >Macintosh Module Reference</a></em></td></tr>
130 <tr><td class="left" valign="baseline"><tt class="file">ref/</tt></td>
131 <td class="left" ><em class="citetitle"><a
132 href="../ref/ref.html"
133 title="Python Reference Manual"
134 >Python Reference Manual</a></em></td></tr>
135 <tr><td class="left" valign="baseline"><tt class="file">tut/</tt></td>
136 <td class="left" ><em class="citetitle"><a
137 href="../tut/tut.html"
138 title="Python Tutorial"
139 >Python Tutorial</a></em></td></tr>
140 <tr><td class="left" valign="baseline"><tt class="file">whatsnew/</tt></td>
141 <td class="left" ><em class="citetitle"><a
142 href="../whatsnew/whatsnew24.html"
143 title="What's New in Python 2.4"
144 >What's New in Python 2.4</a></em></td></tr></tbody>
145</table></div>
146
147<P>
148<dt><b><a id='l2h-2' xml:id='l2h-2'>Format-Specific Output</a></b></dt>
149<dd>
150 Most output formats have a directory which contains a
151 <span class="file">Makefile</span> which controls the generation of that format
152 and provides storage for the formatted documents. The only
153 variations within this category are the Portable Document
154 Format (PDF) and PostScript versions are placed in the
155 directories <span class="file">paper-a4/</span> and <span class="file">paper-letter/</span> (this
156 causes all the temporary files created by <span class="LaTeX">LaTeX</span> to be kept
157 in the same place for each paper size, where they can be more
158 easily ignored).
159
160<P>
161<div class="center"><table class="realtable">
162 <thead>
163 <tr>
164 <th class="left" >Directory</th>
165 <th class="left" >Output Formats</th>
166 </tr>
167 </thead>
168 <tbody>
169 <tr><td class="left" valign="baseline"><tt class="file">html/</tt></td>
170 <td class="left" >HTML output</td></tr>
171 <tr><td class="left" valign="baseline"><tt class="file">info/</tt></td>
172 <td class="left" >GNU info output</td></tr>
173 <tr><td class="left" valign="baseline"><tt class="file">isilo/</tt></td>
174 <td class="left" ><a class="ulink" href="http://www.isilo.com/"
175 >iSilo</a>
176 documents (for Palm OS devices)</td></tr>
177 <tr><td class="left" valign="baseline"><tt class="file">paper-a4/</tt></td>
178 <td class="left" >PDF and PostScript, A4 paper</td></tr>
179 <tr><td class="left" valign="baseline"><tt class="file">paper-letter/</tt></td>
180 <td class="left" >PDF and PostScript, US-Letter paper</td></tr></tbody>
181</table></div>
182
183<P>
184<dt><b><a id='l2h-3' xml:id='l2h-3'>Supplemental Files</a></b></dt>
185<dd>
186 Some additional directories are used to store supplemental
187 files used for the various processes. Directories are
188 included for the shared <span class="LaTeX">LaTeX</span> document classes, the
189 <span class="LaTeX">LaTeX</span>2HTML support, template files for various document
190 components, and the scripts used to perform various steps in
191 the formatting processes.
192
193<P>
194<div class="center"><table class="realtable">
195 <thead>
196 <tr>
197 <th class="left" >Directory</th>
198 <th class="left" >Contents</th>
199 </tr>
200 </thead>
201 <tbody>
202 <tr><td class="left" valign="baseline"><tt class="file">commontex/</tt></td>
203 <td class="left" >Document content shared among documents</td></tr>
204 <tr><td class="left" valign="baseline"><tt class="file">perl/</tt></td>
205 <td class="left" >Support for <span class="LaTeX">LaTeX</span>2HTML processing</td></tr>
206 <tr><td class="left" valign="baseline"><tt class="file">templates/</tt></td>
207 <td class="left" >Example files for source documents</td></tr>
208 <tr><td class="left" valign="baseline"><tt class="file">texinputs/</tt></td>
209 <td class="left" >Style implementation for <span class="LaTeX">LaTeX</span></td></tr>
210 <tr><td class="left" valign="baseline"><tt class="file">tools/</tt></td>
211 <td class="left" >Custom processing scripts</td></tr></tbody>
212</table></div>
213
214<P>
215</dl>
216
217<P>
218
219<DIV CLASS="navigation">
220<div class='online-navigation'>
221<p></p><hr />
222<table align="center" width="100%" cellpadding="0" cellspacing="2">
223<tr>
224<td class='online-navigation'><a rel="prev" title="1 Introduction"
225 href="intro.html"><img src='../icons/previous.png'
226 border='0' height='32' alt='Previous Page' width='32' /></A></td>
227<td class='online-navigation'><a rel="parent" title="Documenting Python"
228 href="doc.html"><img src='../icons/up.png'
229 border='0' height='32' alt='Up One Level' width='32' /></A></td>
230<td class='online-navigation'><a rel="next" title="3 Style Guide"
231 href="style-guide.html"><img src='../icons/next.png'
232 border='0' height='32' alt='Next Page' width='32' /></A></td>
233<td align="center" width="100%">Documenting Python</td>
234<td class='online-navigation'><a rel="contents" title="Table of Contents"
235 href="contents.html"><img src='../icons/contents.png'
236 border='0' height='32' alt='Contents' width='32' /></A></td>
237<td class='online-navigation'><img src='../icons/blank.png'
238 border='0' height='32' alt='' width='32' /></td>
239<td class='online-navigation'><img src='../icons/blank.png'
240 border='0' height='32' alt='' width='32' /></td>
241</tr></table>
242<div class='online-navigation'>
243<b class="navlabel">Previous:</b>
244<a class="sectref" rel="prev" href="intro.html">1 Introduction</A>
245<b class="navlabel">Up:</b>
246<a class="sectref" rel="parent" href="doc.html">Documenting Python</A>
247<b class="navlabel">Next:</b>
248<a class="sectref" rel="next" href="style-guide.html">3 Style Guide</A>
249</div>
250</div>
251<hr />
252<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</span>
253</DIV>
254<!--End of Navigation Panel-->
255<ADDRESS>
256See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
257</ADDRESS>
258</BODY>
259</HTML>
Full OpenSPARC architecture tarball including simulator, hypervisor, and OBP.