Skip to content

Commit

Permalink
Updated docs, added basic python 2.3 example
Browse files Browse the repository at this point in the history
  • Loading branch information
aaron-foreflight authored and Bruce Williams committed May 22, 2009
1 parent cd27f33 commit 6307f24
Show file tree
Hide file tree
Showing 89 changed files with 4,091 additions and 1,093 deletions.
107 changes: 71 additions & 36 deletions docs/api-objects.txt

Large diffs are not rendered by default.

17 changes: 12 additions & 5 deletions docs/class-tree.html
Original file line number Diff line number Diff line change
Expand Up @@ -119,10 +119,10 @@ <h1 class="epydoc">Class Hierarchy</h1>
</li>
<li> <strong class="uidlink"><a href="fiveruns.dash.scm.handler.Handler-class.html">fiveruns.dash.scm.handler.Handler</a></strong>
<ul>
<li> <strong class="uidlink"><a href="fiveruns.dash.scm.handlers._svn.Handler-class.html">fiveruns.dash.scm.handlers._svn.Handler</a></strong>
</li>
<li> <strong class="uidlink"><a href="fiveruns.dash.scm.handlers._git.Handler-class.html">fiveruns.dash.scm.handlers._git.Handler</a></strong>
</li>
<li> <strong class="uidlink"><a href="fiveruns.dash.scm.handlers._svn.Handler-class.html">fiveruns.dash.scm.handlers._svn.Handler</a></strong>
</li>
</ul>
</li>
<li> <strong class="uidlink"><a href="fiveruns.dash.metrics.Metric-class.html">fiveruns.dash.metrics.Metric</a></strong>
Expand All @@ -139,9 +139,12 @@ <h1 class="epydoc">Class Hierarchy</h1>
</li>
<li> <strong class="uidlink"><a href="fiveruns.dash.metrics.MetricSetting-class.html">fiveruns.dash.metrics.MetricSetting</a></strong>
<ul>
<li> <strong class="uidlink"><a href="fiveruns.dash.configuration.Configuration-class.html">fiveruns.dash.configuration.Configuration</a></strong>
<li> <strong class="uidlink"><a href="fiveruns.dash.configuration.Configuration-class.html">fiveruns.dash.configuration.Configuration</a></strong>:
<em class="summary">Configuration parameters for the application being monitored.</em>
</li>
<li> <strong class="uidlink"><a href="fiveruns.dash.recipes.Recipe-class.html">fiveruns.dash.recipes.Recipe</a></strong>
<li> <strong class="uidlink"><a href="fiveruns.dash.recipes.Recipe-class.html">fiveruns.dash.recipes.Recipe</a></strong>:
<em class="summary">A recipe is a collection of metrics that registers itself on
instantiation.</em>
</li>
</ul>
</li>
Expand All @@ -162,8 +165,12 @@ <h1 class="epydoc">Class Hierarchy</h1>
<li> <strong class="uidlink">unittest.TestCase</strong>:
<em class="summary">A class whose instances are single test cases.</em>
<ul>
<li> <strong class="uidlink"><a href="fiveruns.tests.protocol.InfoPayloadTest-class.html">fiveruns.tests.protocol.InfoPayloadTest</a></strong>
</li>
<li> <strong class="uidlink"><a href="fiveruns.tests.recipe_test.RecipeTest-class.html">fiveruns.tests.recipe_test.RecipeTest</a></strong>
</li>
<li> <strong class="uidlink"><a href="fiveruns.tests.recipe.RecipeTest-class.html">fiveruns.tests.recipe.RecipeTest</a></strong>
</li>
</ul>
</li>
<li> <strong class="uidlink">threading._Verbose</strong>
Expand Down Expand Up @@ -205,7 +212,7 @@ <h1 class="epydoc">Class Hierarchy</h1>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Sun May 10 21:06:54 2009
Generated by Epydoc 3.0.1 on Wed May 20 19:07:11 2009
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
Expand Down
2 changes: 1 addition & 1 deletion docs/exceptions.AssertionError-class.html
Original file line number Diff line number Diff line change
Expand Up @@ -267,7 +267,7 @@ <h3 class="epydoc"><span class="sig"><span class="sig-name">__new__</span>(<span
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Sun May 10 21:06:54 2009
Generated by Epydoc 3.0.1 on Wed May 20 19:07:11 2009
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
Expand Down
10 changes: 9 additions & 1 deletion docs/fiveruns-module.html
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,16 @@ <h1 class="epydoc">Package fiveruns</h1><p class="nomargin-top"><span class="cod
<li> <strong class="uidlink"><a href="fiveruns.dash.version-module.html">fiveruns.dash.version</a></strong> </li>
</ul>
</li>
<li> <strong class="uidlink"><a href="fiveruns.recipes-module.html">fiveruns.recipes</a></strong>
<ul>
<li> <strong class="uidlink"><a href="fiveruns.recipes.python-module.html">fiveruns.recipes.python</a></strong> </li>
</ul>
</li>
<li> <strong class="uidlink"><a href="fiveruns.tests-module.html">fiveruns.tests</a></strong>
<ul>
<li> <strong class="uidlink"><a href="fiveruns.tests.helper-module.html">fiveruns.tests.helper</a></strong> </li>
<li> <strong class="uidlink"><a href="fiveruns.tests.protocol-module.html">fiveruns.tests.protocol</a></strong> </li>
<li> <strong class="uidlink"><a href="fiveruns.tests.recipe-module.html">fiveruns.tests.recipe</a></strong> </li>
<li> <strong class="uidlink"><a href="fiveruns.tests.recipe_test-module.html">fiveruns.tests.recipe_test</a></strong> </li>
<li> <strong class="uidlink"><a href="fiveruns.tests.tests-module.html">fiveruns.tests.tests</a></strong> </li>
</ul>
Expand Down Expand Up @@ -132,7 +140,7 @@ <h1 class="epydoc">Package fiveruns</h1><p class="nomargin-top"><span class="cod
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Sun May 10 21:06:54 2009
Generated by Epydoc 3.0.1 on Wed May 20 19:07:11 2009
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
Expand Down
2 changes: 1 addition & 1 deletion docs/fiveruns-pysrc.html
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ <h1 class="epydoc">Source Code for <a href="fiveruns-module.html">Package fiveru
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Sun May 10 21:06:54 2009
Generated by Epydoc 3.0.1 on Wed May 20 19:07:11 2009
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
Expand Down
21 changes: 19 additions & 2 deletions docs/fiveruns.dash-module.html
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,8 @@ <h1 class="epydoc">Package dash</h1><p class="nomargin-top"><span class="codelin
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="start"></a><span class="summary-sig-name">start</span>(<span class="summary-sig-arg">config</span>)</span></td>
<td><span class="summary-sig"><a name="start"></a><span class="summary-sig-name">start</span>(<span class="summary-sig-arg">config</span>)</span><br />
Starts reporting for given configuration</td>
<td align="right" valign="top">
<span class="codelink"><a href="fiveruns.dash-pysrc.html#start">source&nbsp;code</a></span>

Expand Down Expand Up @@ -189,6 +190,22 @@ <h1 class="epydoc">Package dash</h1><p class="nomargin-top"><span class="codelin
</tr>
</table>

</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type">&nbsp;</span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="register_default_recipe"></a><span class="summary-sig-name">register_default_recipe</span>()</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="fiveruns.dash-pysrc.html#register_default_recipe">source&nbsp;code</a></span>

</td>
</tr>
</table>

</td>
</tr>
</table>
Expand Down Expand Up @@ -297,7 +314,7 @@ <h3 class="epydoc"><span class="sig"><span class="sig-name">recipe</span>(<span
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0.1 on Sun May 10 21:06:54 2009
Generated by Epydoc 3.0.1 on Wed May 20 19:07:11 2009
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"
Expand Down
Loading

0 comments on commit 6307f24

Please sign in to comment.