sam-t2/devtools/v9/html/python/doc/directories.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="doc.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python Documentation Index' />
<link rel="first" href="doc.html" title='Documenting Python' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="style-guide.html" />
<link rel="prev" href="intro.html" />
<link rel="parent" href="doc.html" />
<link rel="next" href="style-guide.html" />
<meta name='aesop' content='information' />
<title>2 Directory Structure </title>
</head>
<body>
<DIV CLASS="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="1 Introduction"
  href="intro.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="Documenting Python"
  href="doc.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="3 Style Guide"
  href="style-guide.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Documenting Python</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><img src='../icons/blank.png'
  border='0' height='32'  alt='' width='32' /></td>
<td class='online-navigation'><img src='../icons/blank.png'
  border='0' height='32'  alt='' width='32' /></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="intro.html">1 Introduction</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="doc.html">Documenting Python</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="style-guide.html">3 Style Guide</A>
</div>
<hr /></div>
</DIV>
<!--End of Navigation Panel-->

<H1><A NAME="SECTION000300000000000000000"></A><A NAME="directories"></A>
<BR>
2 Directory Structure
</H1>

<P>
The source distribution for the standard Python documentation
  contains a large number of directories.  While third-party documents
  do not need to be placed into this structure or need to be placed
  within a similar structure, it can be helpful to know where to look
  for examples and tools when developing new documents using the
  Python documentation tools.  This section describes this directory
  structure.

<P>
The documentation sources are usually placed within the Python
  source distribution as the top-level directory <span class="file">Doc/</span>, but
  are not dependent on the Python source distribution in any way.

<P>
The <span class="file">Doc/</span> directory contains a few files and several
  subdirectories.  The files are mostly self-explanatory, including a
  <span class="file">README</span> and a <span class="file">Makefile</span>.  The directories fall into
  three categories:

<P>
<dl class="definitions">
    <dt><b><a id='l2h-1' xml:id='l2h-1'>Document Sources</a></b></dt>
<dd>
        The <span class="LaTeX">LaTeX</span> sources for each document are placed in a
        separate directory.  These directories are given short
        names which vaguely indicate the document in each:

<P>
<div class="center"><table class="realtable">
  <thead>
    <tr>
      <th class="left"  >Directory</th>
      <th class="left"  >Document Title</th>
      </tr>
    </thead>
  <tbody>
    <tr><td class="left"   valign="baseline"><tt class="file">api/</tt></td>
        <td class="left"  ><em class="citetitle"><a
 href="../api/api.html"
 title="The Python/C API"
 >The Python/C API</a></em></td></tr>
    <tr><td class="left"   valign="baseline"><tt class="file">dist/</tt></td>
        <td class="left"  ><em class="citetitle"><a
 href="../dist/dist.html"
 title="Distributing Python Modules"
 >Distributing Python Modules</a></em></td></tr>
    <tr><td class="left"   valign="baseline"><tt class="file">doc/</tt></td>
        <td class="left"  ><em class="citetitle"><a
 href="../doc/doc.html"
 title="Documenting Python"
 >Documenting Python</a></em></td></tr>
    <tr><td class="left"   valign="baseline"><tt class="file">ext/</tt></td>
        <td class="left"  ><em class="citetitle"><a
 href="../ext/ext.html"
 title="Extending and Embedding the Python Interpreter"
 >Extending and Embedding the Python Interpreter</a></em></td></tr>
    <tr><td class="left"   valign="baseline"><tt class="file">inst/</tt></td>
        <td class="left"  ><em class="citetitle"><a
 href="../inst/inst.html"
 title="Installing Python Modules"
 >Installing Python Modules</a></em></td></tr>
    <tr><td class="left"   valign="baseline"><tt class="file">lib/</tt></td>
        <td class="left"  ><em class="citetitle"><a
 href="../lib/lib.html"
 title="Python Library Reference"
 >Python Library Reference</a></em></td></tr>
    <tr><td class="left"   valign="baseline"><tt class="file">mac/</tt></td>
        <td class="left"  ><em class="citetitle"><a
 href="../mac/mac.html"
 title="Macintosh Module Reference"
 >Macintosh Module Reference</a></em></td></tr>
    <tr><td class="left"   valign="baseline"><tt class="file">ref/</tt></td>
        <td class="left"  ><em class="citetitle"><a
 href="../ref/ref.html"
 title="Python Reference Manual"
 >Python Reference Manual</a></em></td></tr>
    <tr><td class="left"   valign="baseline"><tt class="file">tut/</tt></td>
        <td class="left"  ><em class="citetitle"><a
 href="../tut/tut.html"
 title="Python Tutorial"
 >Python Tutorial</a></em></td></tr>
    <tr><td class="left"   valign="baseline"><tt class="file">whatsnew/</tt></td>
        <td class="left"  ><em class="citetitle"><a
 href="../whatsnew/whatsnew24.html"
 title="What's New in Python 2.4"
 >What's New in Python 2.4</a></em></td></tr></tbody>
</table></div>

<P>
<dt><b><a id='l2h-2' xml:id='l2h-2'>Format-Specific Output</a></b></dt>
<dd>
        Most output formats have a directory which contains a
        <span class="file">Makefile</span> which controls the generation of that format
        and provides storage for the formatted documents.  The only
        variations within this category are the Portable Document
        Format (PDF) and PostScript versions are placed in the
        directories <span class="file">paper-a4/</span> and <span class="file">paper-letter/</span> (this
        causes all the temporary files created by <span class="LaTeX">LaTeX</span> to be kept
        in the same place for each paper size, where they can be more
        easily ignored).

<P>
<div class="center"><table class="realtable">
  <thead>
    <tr>
      <th class="left"  >Directory</th>
      <th class="left"  >Output Formats</th>
      </tr>
    </thead>
  <tbody>
    <tr><td class="left"   valign="baseline"><tt class="file">html/</tt></td>
        <td class="left"  >HTML output</td></tr>
    <tr><td class="left"   valign="baseline"><tt class="file">info/</tt></td>
        <td class="left"  >GNU info output</td></tr>
    <tr><td class="left"   valign="baseline"><tt class="file">isilo/</tt></td>
        <td class="left"  ><a class="ulink" href="http://www.isilo.com/"
  >iSilo</a>
                          documents (for Palm OS devices)</td></tr>
    <tr><td class="left"   valign="baseline"><tt class="file">paper-a4/</tt></td>
        <td class="left"  >PDF and PostScript, A4 paper</td></tr>
    <tr><td class="left"   valign="baseline"><tt class="file">paper-letter/</tt></td>
        <td class="left"  >PDF and PostScript, US-Letter paper</td></tr></tbody>
</table></div>

<P>
<dt><b><a id='l2h-3' xml:id='l2h-3'>Supplemental Files</a></b></dt>
<dd>
        Some additional directories are used to store supplemental
        files used for the various processes.  Directories are
        included for the shared <span class="LaTeX">LaTeX</span> document classes, the
        <span class="LaTeX">LaTeX</span>2HTML support, template files for various document
        components, and the scripts used to perform various steps in
        the formatting processes.

<P>
<div class="center"><table class="realtable">
  <thead>
    <tr>
      <th class="left"  >Directory</th>
      <th class="left"  >Contents</th>
      </tr>
    </thead>
  <tbody>
    <tr><td class="left"   valign="baseline"><tt class="file">commontex/</tt></td>
        <td class="left"  >Document content shared among documents</td></tr>
    <tr><td class="left"   valign="baseline"><tt class="file">perl/</tt></td>
        <td class="left"  >Support for <span class="LaTeX">LaTeX</span>2HTML processing</td></tr>
    <tr><td class="left"   valign="baseline"><tt class="file">templates/</tt></td>
        <td class="left"  >Example files for source documents</td></tr>
    <tr><td class="left"   valign="baseline"><tt class="file">texinputs/</tt></td>
        <td class="left"  >Style implementation for <span class="LaTeX">LaTeX</span></td></tr>
    <tr><td class="left"   valign="baseline"><tt class="file">tools/</tt></td>
        <td class="left"  >Custom processing scripts</td></tr></tbody>
</table></div>

<P>
</dl>

<P>

<DIV CLASS="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="1 Introduction"
  href="intro.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></A></td>
<td class='online-navigation'><a rel="parent" title="Documenting Python"
  href="doc.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up One Level' width='32' /></A></td>
<td class='online-navigation'><a rel="next" title="3 Style Guide"
  href="style-guide.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></A></td>
<td align="center" width="100%">Documenting Python</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></A></td>
<td class='online-navigation'><img src='../icons/blank.png'
  border='0' height='32'  alt='' width='32' /></td>
<td class='online-navigation'><img src='../icons/blank.png'
  border='0' height='32'  alt='' width='32' /></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="intro.html">1 Introduction</A>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="doc.html">Documenting Python</A>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="style-guide.html">3 Style Guide</A>
</div>
</div>
<hr />
<span class="release-info">Release 2.4.2, documentation updated on 28 September 2005.</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>