diff options
Diffstat (limited to 'doc/html/example-module.html')
| -rw-r--r-- | doc/html/example-module.html | 316 |
1 files changed, 0 insertions, 316 deletions
diff --git a/doc/html/example-module.html b/doc/html/example-module.html deleted file mode 100644 index f08370632..000000000 --- a/doc/html/example-module.html +++ /dev/null @@ -1,316 +0,0 @@ -<?xml version="1.0" encoding="ascii"?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" - "DTD/xhtml1-transitional.dtd"> -<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> -<head> - <title>example</title> - <link rel="stylesheet" href="epydoc.css" type="text/css" /> - <script type="text/javascript" src="epydoc.js"></script> -</head> - -<body bgcolor="white" text="black" link="blue" vlink="#204080" - alink="#204080"> -<!-- ==================== NAVIGATION BAR ==================== --> -<table class="navbar" border="0" width="100%" cellpadding="0" - bgcolor="#a0c0ff" cellspacing="0"> - <tr valign="middle"> - <!-- Home link --> - <th bgcolor="#70b0f0" class="navbar-select" - > Home </th> - - <!-- Tree link --> - <th> <a - href="module-tree.html">Trees</a> </th> - - <!-- Index link --> - <th> <a - href="identifier-index.html">Indices</a> </th> - - <!-- Help link --> - <th> <a - href="help.html">Help</a> </th> - - <th class="navbar" width="100%"></th> - </tr> -</table> -<table width="100%" cellpadding="0" cellspacing="0"> - <tr valign="top"> - <td width="100%"> - <span class="breadcrumbs"> - Module example - </span> - </td> - <td> - <table cellpadding="0" cellspacing="0"> - <!-- hide/show private --> - <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" - onclick="toggle_private();">hide private</a>]</span></td></tr> - <tr><td align="right"><span class="options" - >[<a href="frames.html" target="_top">frames</a - >] | <a href="example-module.html" - target="_top">no frames</a>]</span></td></tr> - </table> - </td> - </tr> -</table> -<!-- ==================== MODULE DESCRIPTION ==================== --> -<h1 class="epydoc">Module example</h1><p class="nomargin-top"><span class="codelink"><a href="example-pysrc.html">source code</a></span></p> -<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.</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.</p> - -<!-- ==================== FUNCTIONS ==================== --> -<a name="section-Functions"></a> -<table class="summary" border="1" cellpadding="3" - cellspacing="0" width="100%" bgcolor="white"> -<tr bgcolor="#70b0f0" class="table-header"> - <td colspan="2" class="table-header"> - <table border="0" cellpadding="0" cellspacing="0" width="100%"> - <tr valign="top"> - <td align="left"><span class="table-header">Functions</span></td> - <td align="right" valign="top" - ><span class="options">[<a href="#section-Functions" - class="privatelink" onclick="toggle_private();" - >hide private</a>]</span></td> - </tr> - </table> - </td> -</tr> -<tr> - <td width="15%" align="right" valign="top" class="summary"> - <span class="summary-type"> </span> - </td><td class="summary"> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr> - <td><span class="summary-sig"><a href="example-module.html#foo" class="summary-sig-name">foo</a>(<span class="summary-sig-arg">var1</span>, - <span class="summary-sig-arg">var2</span>, - <span class="summary-sig-arg">long_var_name</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">hi</code><code class="variable-quote">'</code></span>)</span><br /> - One-line summary or signature.</td> - <td align="right" valign="top"> - <span class="codelink"><a href="example-pysrc.html#foo">source code</a></span> - - </td> - </tr> - </table> - - </td> - </tr> -<tr> - <td width="15%" align="right" valign="top" class="summary"> - <span class="summary-type"> </span> - </td><td class="summary"> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr> - <td><span class="summary-sig"><a href="example-module.html#newfunc" class="summary-sig-name">newfunc</a>()</span><br /> - Do nothing.</td> - <td align="right" valign="top"> - <span class="codelink"><a href="example-pysrc.html#newfunc">source code</a></span> - - </td> - </tr> - </table> - - </td> - </tr> -<tr> - <td width="15%" align="right" valign="top" class="summary"> - <span class="summary-type"> </span> - </td><td class="summary"> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr> - <td><span class="summary-sig"><a href="example-module.html#otherfunc" class="summary-sig-name">otherfunc</a>()</span><br /> - Do nothing.</td> - <td align="right" valign="top"> - <span class="codelink"><a href="example-pysrc.html#otherfunc">source code</a></span> - - </td> - </tr> - </table> - - </td> - </tr> -</table> -<!-- ==================== FUNCTION DETAILS ==================== --> -<a name="section-FunctionDetails"></a> -<table class="details" border="1" cellpadding="3" - cellspacing="0" width="100%" bgcolor="white"> -<tr bgcolor="#70b0f0" class="table-header"> - <td colspan="2" class="table-header"> - <table border="0" cellpadding="0" cellspacing="0" width="100%"> - <tr valign="top"> - <td align="left"><span class="table-header">Function Details</span></td> - <td align="right" valign="top" - ><span class="options">[<a href="#section-FunctionDetails" - class="privatelink" onclick="toggle_private();" - >hide private</a>]</span></td> - </tr> - </table> - </td> -</tr> -</table> -<a name="foo"></a> -<div> -<table class="details" border="1" cellpadding="3" - cellspacing="0" width="100%" bgcolor="white"> -<tr><td> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr valign="top"><td> - <h3 class="epydoc"><span class="sig"><span class="sig-name">foo</span>(<span class="sig-arg">var1</span>, - <span class="sig-arg">var2</span>, - <span class="sig-arg">long_var_name</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string">hi</code><code class="variable-quote">'</code></span>)</span> - </h3> - </td><td align="right" valign="top" - ><span class="codelink"><a href="example-pysrc.html#foo">source code</a></span> - </td> - </tr></table> - - <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> -<div class="rst-section" id="rst-parameters"> -<h1 class="heading">Parameters</h1> -<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> -</div> -<div class="rst-section" id="rst-returns"> -<h1 class="heading">Returns</h1> -<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> -</div> -<div class="rst-section" id="rst-other-parameters"> -<h1 class="heading">Other Parameters</h1> -<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> -</div> -<div class="rst-section" id="rst-see-also"> -<h1 class="heading">See Also</h1> -<p>otherfunc : relationship (optional) -newfunc : relationship (optional)</p> -</div> -<div class="rst-section" id="rst-notes"> -<h1 class="heading">Notes</h1> -<p>Notes about the implementation algorithm (if needed).</p> -<p>This can have multiple paragraphs as can all sections.</p> -</div> -<div class="rst-section" id="rst-examples"> -<h1 class="heading">Examples</h1> -<p>examples in doctest format</p> -<pre class="py-doctest"> -<span class="py-prompt">>>> </span>a=[1,2,3] -<span class="py-prompt">>>> </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> -</div> - <dl class="fields"> - </dl> -</td></tr></table> -</div> -<a name="newfunc"></a> -<div> -<table class="details" border="1" cellpadding="3" - cellspacing="0" width="100%" bgcolor="white"> -<tr><td> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr valign="top"><td> - <h3 class="epydoc"><span class="sig"><span class="sig-name">newfunc</span>()</span> - </h3> - </td><td align="right" valign="top" - ><span class="codelink"><a href="example-pysrc.html#newfunc">source code</a></span> - </td> - </tr></table> - - <p>Do nothing.</p> -<p>I never saw a purple cow.</p> - <dl class="fields"> - </dl> -</td></tr></table> -</div> -<a name="otherfunc"></a> -<div> -<table class="details" border="1" cellpadding="3" - cellspacing="0" width="100%" bgcolor="white"> -<tr><td> - <table width="100%" cellpadding="0" cellspacing="0" border="0"> - <tr valign="top"><td> - <h3 class="epydoc"><span class="sig"><span class="sig-name">otherfunc</span>()</span> - </h3> - </td><td align="right" valign="top" - ><span class="codelink"><a href="example-pysrc.html#otherfunc">source code</a></span> - </td> - </tr></table> - - <p>Do nothing.</p> -<p>I never hope to see one.</p> - <dl class="fields"> - </dl> -</td></tr></table> -</div> -<br /> -<!-- ==================== NAVIGATION BAR ==================== --> -<table class="navbar" border="0" width="100%" cellpadding="0" - bgcolor="#a0c0ff" cellspacing="0"> - <tr valign="middle"> - <!-- Home link --> - <th bgcolor="#70b0f0" class="navbar-select" - > Home </th> - - <!-- Tree link --> - <th> <a - href="module-tree.html">Trees</a> </th> - - <!-- Index link --> - <th> <a - href="identifier-index.html">Indices</a> </th> - - <!-- Help link --> - <th> <a - href="help.html">Help</a> </th> - - <th class="navbar" width="100%"></th> - </tr> -</table> -<table border="0" cellpadding="0" cellspacing="0" width="100%%"> - <tr> - <td align="left" class="footer"> - Generated by Epydoc 3.0beta1 on Tue Jan 22 00:26:36 2008 - </td> - <td align="right" class="footer"> - <a target="mainFrame" href="http://epydoc.sourceforge.net" - >http://epydoc.sourceforge.net</a> - </td> - </tr> -</table> - -<script type="text/javascript"> - <!-- - // Private objects are initially displayed (because if - // javascript is turned off then we want them to be - // visible); but by default, we want to hide them. So hide - // them unless we have a cookie that says to show them. - checkCookie(); - // --> -</script> -</body> -</html> |