[Epydoc-commits] SF.net SVN: epydoc: [1537] trunk/epydoc/doc/using.html

[<dva...@us...>]

Revision: 1537
          http://svn.sourceforge.net/epydoc/?rev=1537&view=rev
Author:   dvarrazzo
Date:     2007-02-19 17:38:37 -0800 (Mon, 19 Feb 2007)

Log Message:
-----------
- Generated HTML pages description updated.

Modified Paths:
--------------
    trunk/epydoc/doc/using.html

Modified: trunk/epydoc/doc/using.html
===================================================================
--- trunk/epydoc/doc/using.html	2007-02-19 22:59:58 UTC (rev 1536)
+++ trunk/epydoc/doc/using.html	2007-02-20 01:38:37 UTC (rev 1537)
@@ -23,7 +23,7 @@
 <p>Epydoc can also be accessed programmatically; see epydoc's <a
 href="api/">API documentation</a> for more information. </p>
 
-<a name="cli"><h2> The Command Line Interface </h2></a>
+<a name="cli"></a><h2> The Command Line Interface </h2>
 
 <p> The <code>epydoc</code> script extracts API documentation for a
 set of python objects, and writes it using a selected output format.
@@ -324,9 +324,8 @@
 
 <a name="files"><h2> HTML Files </h2></a>
 
-<p> Epydoc creates two subdirectories, for the public and private
-    documentation.  Within each subdirectory, every module and class
-    is documented in its own file.  An index file, a trees file, a
+<p> Every Python module and class
+    is documented in its own file.  Index files, tree files, a
     help file, and a frames-based table of contents are also created.
     The following list describes each of the files generated by
     epydoc: </p>
@@ -350,16 +349,58 @@
   complete dotted name of the class, such as epydoc.epytext.Token or
   array.ArrayType.  </li>
 
-  <li><b><code>trees.html</code></b>
-  The module and class hierarchies.  </li>
+  <li><b><code><code class="user">module</code>-pysrc.html</code></b>
+  A page with the module colourized source code, with links back to the
+  objects main documentation pages. The creation of the colourized source
+  pages can be controlled using the options <code>--show-sourcecode</code> and
+  <code>--no-sourcecode</code>.</li>
 
-  <li><b><code>indices.html</code></b>
-  The term and identifier indices.  </li>
+  <li><b><code>module-tree.html</code></b>
+  The documented module hierarchy.  </li>
 
+  <li><b><code>class-tree.html</code></b>
+  The documented classes hierarchy.  </li>
+
+  <li><b><code>identifier-index.html</code></b>
+  The index of all the identifiers found in the documented items.  </li>
+
+  <li><b><code>term-index.html</code></b>
+  The index of all the term definition found in the docstrings.
+  Term definitions are created using the <a href="epytext.html#indexed">Indexed
+  Term</a> markup. </li>
+
+  <li><b><code>bug-index.html</code></b>
+  The index of all the known bug in the documented sources.
+  Bugs are marked using the <code>@bug</code> tag. </li>
+
+  <li><b><code>todo-index.html</code></b>
+  The index of all the <i>to-do</i> items in the documented sources.
+  They are marked using the <code>@todo</code> tag. </li>
+
   <li><b><code>help.html</code></b>
   The help page for the project.  This page explains how to use and
   navigate the webpage produced by epydoc.  </li>
 
+  <li><b><code>epydoc-log.html</code></b>
+  A page with the log of the epydoc execution. It is available clicking on the
+  timestamp below each page, if the documentation was created using the
+  <code>--include-log</code> option. The page also contains the list of the
+  options enabled when the documentation was created. </li>
+
+  <li><b><code>api-objects.txt</code></b>
+  A text file containing each available item and the url where it is
+  documented. Each item takes a file line and it is separated by the URL
+  by a <code>tab</code> charecter. Such file can be used to create documents
+  linkig to the API: see the <code>--external-api</code> documentation for
+  details.</li>
+
+  <li><b><code>redirect.html</code></b>
+  A page containing Javascript code that redirect the browser to the
+  documetation page indicated by the accessed fragment. For example opening
+  the page <code>redirect.html#epydoc.apidoc.DottedName</code> the browser
+  will be redirected to the page
+  <code>/epydoc.apidoc.DottedName-class.html</code>.</li>
+
   <li><b><code>frames.html</code></b>
   The main frames file.  Two frames on the left side of the window
   contain a table of contents, and the main frame on the right side of


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.