[Numpy-svn] r4107 - trunk/numpy/doc/html

numpy-svn@scip... numpy-svn@scip...
Sun Sep 23 15:30:56 CDT 2007


Author: jarrod.millman
Date: 2007-09-23 15:30:51 -0500 (Sun, 23 Sep 2007)
New Revision: 4107

Modified:
   trunk/numpy/doc/html/example-module.html
   trunk/numpy/doc/html/example-pysrc.html
   trunk/numpy/doc/html/help.html
   trunk/numpy/doc/html/identifier-index.html
   trunk/numpy/doc/html/module-tree.html
Log:
correcting epydoc output


Modified: trunk/numpy/doc/html/example-module.html
===================================================================
--- trunk/numpy/doc/html/example-module.html	2007-09-23 14:39:10 UTC (rev 4106)
+++ trunk/numpy/doc/html/example-module.html	2007-09-23 20:30:51 UTC (rev 4107)
@@ -55,18 +55,14 @@
 </table>
 <!-- ==================== MODULE DESCRIPTION ==================== -->
 <h1 class="epydoc">Module example</h1><p class="nomargin-top"><span class="codelink"><a href="example-pysrc.html">source&nbsp;code</a></span></p>
-<pre class="literalblock">
-This is the docstring for the example.py module.  Modules names should
+<p>This is the docstring for the example.py module.  Modules names should
 have short, all-lowercase names.  The module name may have underscores if
-this improves readability.
-
-Every module should have a docstring at the very top of the file.  The
+this improves readability.</p>
+<p>Every module should have a docstring at the very top of the file.  The
 module's docstring may extend over multiple lines.  If your docstring does
 extend over multiple lines, the closing three quotation marks must be on
-a line by itself, preferably preceeded by a blank line.
+a line by itself, preferably preceeded by a blank line.</p>
 
-</pre>
-
 <!-- ==================== FUNCTIONS ==================== -->
 <a name="section-Functions"></a>
 <table class="summary" border="1" cellpadding="3"
@@ -172,61 +168,61 @@
     </td>
   </table>
   
-  <pre class="literalblock">
-One-line summary or signature.
-
-Several sentences providing an extended description. You can put
-text in mono-spaced type like so: ``var``.
-
-*Parameters*:
-
-    var1 : {array_like}
-        Array_like means all those objects -- lists, nested lists, etc. --
-        that can be converted to an array.
-    var2 : {integer}
-        Write out the full type
-    long_variable_name : {'hi', 'ho'}, optional
-        Choices in brackets, default first when optional.
-
-*Returns*:
-
-    named : {type}
-        Explanation
-    list
-        Explanation
-    of
-        Explanation
-    outputs
-        even more explaining
-
-*Other Parameters*:
-
-    only_seldom_used_keywords : type
-        Explanation
-    common_parametrs_listed_above : type
-        Explanation
-
-*See Also*:
-
-    `otherfunc` : relationship (optional)
-
-    `newfunc` : relationship (optional)
-
-*Notes*
-
-    Notes about the implementation algorithm (if needed).
-
-    This can have multiple paragraphs as can all sections.
-
-*Examples*
-
-    examples in doctest format
-
-    &gt;&gt;&gt; a=[1,2,3]
-    &gt;&gt;&gt; [x + 3 for x in a]
-    [4, 5, 6]
-
-</pre>
+  <p>One-line summary or signature.</p>
+<p>Several sentences providing an extended description. You can put
+text in mono-spaced type like so: <tt class="rst-docutils literal"><span class="pre">var</span></tt>.</p>
+<p><em>Parameters</em>:</p>
+<blockquote>
+<dl class="rst-docutils">
+<dt>var1 <span class="classifier-delimiter">:</span> <span class="rst-classifier">{array_like}</span></dt>
+<dd>Array_like means all those objects -- lists, nested lists, etc. --
+that can be converted to an array.</dd>
+<dt>var2 <span class="classifier-delimiter">:</span> <span class="rst-classifier">{integer}</span></dt>
+<dd>Write out the full type</dd>
+<dt>long_variable_name <span class="classifier-delimiter">:</span> <span class="rst-classifier">{'hi', 'ho'}, optional</span></dt>
+<dd>Choices in brackets, default first when optional.</dd>
+</dl>
+</blockquote>
+<p><em>Returns</em>:</p>
+<blockquote>
+<dl class="rst-docutils">
+<dt>named <span class="classifier-delimiter">:</span> <span class="rst-classifier">{type}</span></dt>
+<dd>Explanation</dd>
+<dt>list</dt>
+<dd>Explanation</dd>
+<dt>of</dt>
+<dd>Explanation</dd>
+<dt>outputs</dt>
+<dd>even more explaining</dd>
+</dl>
+</blockquote>
+<p><em>Other Parameters</em>:</p>
+<blockquote>
+<dl class="rst-docutils">
+<dt>only_seldom_used_keywords <span class="classifier-delimiter">:</span> <span class="rst-classifier">type</span></dt>
+<dd>Explanation</dd>
+<dt>common_parametrs_listed_above <span class="classifier-delimiter">:</span> <span class="rst-classifier">type</span></dt>
+<dd>Explanation</dd>
+</dl>
+</blockquote>
+<p><em>See Also</em>:</p>
+<blockquote>
+<p><a href="example-module.html#otherfunc" class="link">otherfunc</a> : relationship (optional)</p>
+<p><a href="example-module.html#newfunc" class="link">newfunc</a> : relationship (optional)</p>
+</blockquote>
+<p><em>Notes</em></p>
+<blockquote>
+<p>Notes about the implementation algorithm (if needed).</p>
+<p>This can have multiple paragraphs as can all sections.</p>
+</blockquote>
+<p><em>Examples</em></p>
+<blockquote>
+<p>examples in doctest format</p>
+<pre class="py-doctest">
+<span class="py-prompt">&gt;&gt;&gt; </span>a=[1,2,3]
+<span class="py-prompt">&gt;&gt;&gt; </span>[x + 3 <span class="py-keyword">for</span> x <span class="py-keyword">in</span> a]
+<span class="py-output">[4, 5, 6]</span></pre>
+</blockquote>
   <dl class="fields">
   </dl>
 </td></tr></table>
@@ -245,12 +241,8 @@
     </td>
   </table>
   
-  <pre class="literalblock">
-Do nothing.
-
-I never saw a purple cow.
-
-</pre>
+  <p>Do nothing.</p>
+<p>I never saw a purple cow.</p>
   <dl class="fields">
   </dl>
 </td></tr></table>
@@ -269,12 +261,8 @@
     </td>
   </table>
   
-  <pre class="literalblock">
-Do nothing.
-
-I never hope to see one.
-
-</pre>
+  <p>Do nothing.</p>
+<p>I never hope to see one.</p>
   <dl class="fields">
   </dl>
 </td></tr></table>
@@ -306,7 +294,7 @@
 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
   <tr>
     <td align="left" class="footer">
-    Generated by Epydoc 3.0beta1 on Sun Sep 23 07:36:32 2007
+    Generated by Epydoc 3.0beta1 on Sun Sep 23 13:30:28 2007
     </td>
     <td align="right" class="footer">
       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>

Modified: trunk/numpy/doc/html/example-pysrc.html
===================================================================
--- trunk/numpy/doc/html/example-pysrc.html	2007-09-23 14:39:10 UTC (rev 4106)
+++ trunk/numpy/doc/html/example-pysrc.html	2007-09-23 20:30:51 UTC (rev 4107)
@@ -186,7 +186,7 @@
 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
   <tr>
     <td align="left" class="footer">
-    Generated by Epydoc 3.0beta1 on Sun Sep 23 07:36:32 2007
+    Generated by Epydoc 3.0beta1 on Sun Sep 23 13:30:28 2007
     </td>
     <td align="right" class="footer">
       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>

Modified: trunk/numpy/doc/html/help.html
===================================================================
--- trunk/numpy/doc/html/help.html	2007-09-23 14:39:10 UTC (rev 4106)
+++ trunk/numpy/doc/html/help.html	2007-09-23 20:30:51 UTC (rev 4107)
@@ -246,7 +246,7 @@
 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
   <tr>
     <td align="left" class="footer">
-    Generated by Epydoc 3.0beta1 on Sun Sep 23 07:36:32 2007
+    Generated by Epydoc 3.0beta1 on Sun Sep 23 13:30:28 2007
     </td>
     <td align="right" class="footer">
       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>

Modified: trunk/numpy/doc/html/identifier-index.html
===================================================================
--- trunk/numpy/doc/html/identifier-index.html	2007-09-23 14:39:10 UTC (rev 4106)
+++ trunk/numpy/doc/html/identifier-index.html	2007-09-23 20:30:51 UTC (rev 4107)
@@ -158,7 +158,7 @@
 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
   <tr>
     <td align="left" class="footer">
-    Generated by Epydoc 3.0beta1 on Sun Sep 23 07:36:32 2007
+    Generated by Epydoc 3.0beta1 on Sun Sep 23 13:30:28 2007
     </td>
     <td align="right" class="footer">
       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>

Modified: trunk/numpy/doc/html/module-tree.html
===================================================================
--- trunk/numpy/doc/html/module-tree.html	2007-09-23 14:39:10 UTC (rev 4106)
+++ trunk/numpy/doc/html/module-tree.html	2007-09-23 20:30:51 UTC (rev 4107)
@@ -79,7 +79,7 @@
 <table border="0" cellpadding="0" cellspacing="0" width="100%%">
   <tr>
     <td align="left" class="footer">
-    Generated by Epydoc 3.0beta1 on Sun Sep 23 07:36:32 2007
+    Generated by Epydoc 3.0beta1 on Sun Sep 23 13:30:28 2007
     </td>
     <td align="right" class="footer">
       <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>



More information about the Numpy-svn mailing list