Skip to content

Commit

Permalink
Added autodoc to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
afaulconbridge committed Mar 1, 2011
1 parent 4cc1037 commit d753970
Show file tree
Hide file tree
Showing 13 changed files with 513 additions and 5 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ docs:
sphinx-build -b latex -d doc/build/doctrees -D latex_paper_size=a4 doc/source doc/latex
#pdflatex is invoced via this shell script
#so that paths are local and its run repeatedly
doc/latex/runlatex.sh
doc/latex/runlatex.sh > /dev/null

89 changes: 89 additions & 0 deletions doc/html/_modules/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@


<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>Overview: module code &mdash; PyGA v0.1.1 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.1.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="PyGA v0.1.1 documentation" href="../index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../index.html">PyGA v0.1.1 documentation</a> &raquo;</li>
</ul>
</div>

<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">

<h1>All modules for which code is available</h1>
<ul><li><a href="pyga.html">pyga</a></li>
</ul>

</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../index.html">PyGA v0.1.1 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2011, Adam Faulconbridge.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
</div>
</body>
</html>
251 changes: 251 additions & 0 deletions doc/html/_modules/pyga.html

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion doc/html/_sources/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ Contents:
.. toctree::
:maxdepth: 2


.. automodule:: pyga
:members:
25 changes: 24 additions & 1 deletion doc/html/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ <h3>Navigation</h3>
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">PyGA v0.1.1 documentation</a> &raquo;</li>
</ul>
</div>
Expand All @@ -44,8 +47,25 @@ <h3>Navigation</h3>
<h1 id="index">Index</h1>

<div class="genindex-jumpbox">

<a href="#G"><strong>G</strong></a> | <a href="#P"><strong>P</strong></a>
</div>
<h2 id="G">G</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="index.html#pyga.Gene">Gene (class in pyga)</a></dt>
</dl></td>
<td style="width: 33%" valign="top"><dl>
<dt><a href="index.html#pyga.GeneticAlg">GeneticAlg (class in pyga)</a></dt>
</dl></td>
</tr></table>

<h2 id="P">P</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%" valign="top"><dl>
<dt><a href="index.html#module-pyga">pyga (module)</a></dt>
</dl></td>
</tr></table>



</div>
Expand Down Expand Up @@ -79,6 +99,9 @@ <h3>Navigation</h3>
<li class="right" style="margin-right: 10px">
<a href="#" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">PyGA v0.1.1 documentation</a> &raquo;</li>
</ul>
</div>
Expand Down
25 changes: 25 additions & 0 deletions doc/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ <h3>Navigation</h3>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="#">PyGA v0.1.1 documentation</a> &raquo;</li>
</ul>
</div>
Expand All @@ -47,6 +50,25 @@ <h1>Welcome to PyGA&#8217;s documentation!<a class="headerlink" href="#welcome-t
<ul class="simple">
</ul>
</div>
<span class="target" id="module-pyga"></span><p>This is the core module for pyga.</p>
<p>Here are the basic vanilla components; genes and a GA.
Other variations are sub-classes of these.</p>
<dl class="class">
<dt id="pyga.Gene">
<em class="property">class </em><tt class="descclassname">pyga.</tt><tt class="descname">Gene</tt><big>(</big><em>values=(None</em>, <em>)</em><big>)</big><a class="reference internal" href="_modules/pyga.html#Gene"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyga.Gene" title="Permalink to this definition"></a></dt>
<dd><p>&#8221;
This is the base class for Gene objects. These do not
represent a specific gene on one chromosme, rather
it representes all possible genes that exist at that
position - the different alleles (values).</p>
</dd></dl>

<dl class="class">
<dt id="pyga.GeneticAlg">
<em class="property">class </em><tt class="descclassname">pyga.</tt><tt class="descname">GeneticAlg</tt><big>(</big><em>size</em>, <em>generations</em>, <em>chromosomepattern</em>, <em>chromosomecount</em>, <em>survival</em>, <em>rng=None</em><big>)</big><a class="reference internal" href="_modules/pyga.html#GeneticAlg"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyga.GeneticAlg" title="Permalink to this definition"></a></dt>
<dd><p>Base class for the GA itself.</p>
</dd></dl>

</div>


Expand Down Expand Up @@ -83,6 +105,9 @@ <h3>Navigation</h3>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="#">PyGA v0.1.1 documentation</a> &raquo;</li>
</ul>
</div>
Expand Down
Binary file modified doc/html/objects.inv
Binary file not shown.
111 changes: 111 additions & 0 deletions doc/html/py-modindex.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@


<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>Python Module Index &mdash; PyGA v0.1.1 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '0.1.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="PyGA v0.1.1 documentation" href="index.html" />


<script type="text/javascript">
DOCUMENTATION_OPTIONS.COLLAPSE_INDEX = true;
</script>


</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="#" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">PyGA v0.1.1 documentation</a> &raquo;</li>
</ul>
</div>

<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">


<h1>Python Module Index</h1>

<div class="modindex-jumpbox">
<a href="#cap-p"><strong>p</strong></a>
</div>

<table class="indextable modindextable" cellspacing="0" cellpadding="2">
<tr class="pcap"><td></td><td>&nbsp;</td><td></td></tr>
<tr class="cap" id="cap-p"><td></td><td>
<strong>p</strong></td><td></td></tr>
<tr>
<td></td>
<td>
<a href="index.html#module-pyga"><tt class="xref">pyga</tt></a></td><td>
<em></em></td></tr>
</table>


</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="#" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">PyGA v0.1.1 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2011, Adam Faulconbridge.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
</div>
</body>
</html>
6 changes: 6 additions & 0 deletions doc/html/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ <h3>Navigation</h3>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">PyGA v0.1.1 documentation</a> &raquo;</li>
</ul>
</div>
Expand Down Expand Up @@ -85,6 +88,9 @@ <h3>Navigation</h3>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="index.html">PyGA v0.1.1 documentation</a> &raquo;</li>
</ul>
</div>
Expand Down
2 changes: 1 addition & 1 deletion doc/html/searchindex.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Binary file modified doc/latex/PyGA.pdf
Binary file not shown.
1 change: 1 addition & 0 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#sys.path.insert(0, os.path.abspath('.'))
sys.path.insert(0, os.path.abspath('../..'))

# -- General configuration -----------------------------------------------------

Expand Down
3 changes: 2 additions & 1 deletion doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ Contents:
.. toctree::
:maxdepth: 2


.. automodule:: pyga
:members:

0 comments on commit d753970

Please sign in to comment.