Skip to content

Commit

Permalink
rebuild documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Mark Fiers committed May 24, 2012
1 parent 8cc24c3 commit 957fc90
Show file tree
Hide file tree
Showing 56 changed files with 3,648 additions and 63 deletions.
49 changes: 22 additions & 27 deletions _sources/api/plugin/index.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,26 @@ moa.plugin
.. toctree::
:maxdepth: 2

adhoc
checkversion
configure
doc
extraCommands
fileset
help
info
lock
logger
logo
mail
metavar
moaGit
moautil
newjob
parameterCheck
project
prompt
report
sgeActor
status
template
test
twit
umask
varInject
job__metavar
system__adhoc
system__configure
system__doc
system__extraCommands
system__fileset
system__help
system__info
system__lock
system__logger
system__moaGit
system__moautil
system__newjob
system__parameterCheck
system__project
system__remoteLogger
system__smw
system__status
system__template
system__test
system__umask
system__varInject

2 changes: 2 additions & 0 deletions _sources/api/plugin/job__metavar.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. automodule:: moa.plugin.job.metavar
:members:
2 changes: 2 additions & 0 deletions _sources/api/plugin/system__adhoc.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. automodule:: moa.plugin.system.adhoc
:members:
2 changes: 2 additions & 0 deletions _sources/api/plugin/system__configure.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. automodule:: moa.plugin.system.configure
:members:
2 changes: 2 additions & 0 deletions _sources/api/plugin/system__doc.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. automodule:: moa.plugin.system.doc
:members:
2 changes: 2 additions & 0 deletions _sources/api/plugin/system__extraCommands.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. automodule:: moa.plugin.system.extraCommands
:members:
2 changes: 2 additions & 0 deletions _sources/api/plugin/system__fileset.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. automodule:: moa.plugin.system.fileset
:members:
2 changes: 2 additions & 0 deletions _sources/api/plugin/system__help.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. automodule:: moa.plugin.system.help
:members:
2 changes: 2 additions & 0 deletions _sources/api/plugin/system__info.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. automodule:: moa.plugin.system.info
:members:
2 changes: 2 additions & 0 deletions _sources/api/plugin/system__lock.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. automodule:: moa.plugin.system.lock
:members:
2 changes: 2 additions & 0 deletions _sources/api/plugin/system__logger.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. automodule:: moa.plugin.system.logger
:members:
2 changes: 2 additions & 0 deletions _sources/api/plugin/system__moaGit.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. automodule:: moa.plugin.system.moaGit
:members:
2 changes: 2 additions & 0 deletions _sources/api/plugin/system__moautil.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. automodule:: moa.plugin.system.moautil
:members:
2 changes: 2 additions & 0 deletions _sources/api/plugin/system__newjob.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. automodule:: moa.plugin.system.newjob
:members:
2 changes: 2 additions & 0 deletions _sources/api/plugin/system__parameterCheck.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. automodule:: moa.plugin.system.parameterCheck
:members:
2 changes: 2 additions & 0 deletions _sources/api/plugin/system__project.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. automodule:: moa.plugin.system.project
:members:
2 changes: 2 additions & 0 deletions _sources/api/plugin/system__remoteLogger.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. automodule:: {}
:members:
2 changes: 2 additions & 0 deletions _sources/api/plugin/system__smw.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. automodule:: moa.plugin.system.smw
:members:
2 changes: 2 additions & 0 deletions _sources/api/plugin/system__status.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. automodule:: moa.plugin.system.status
:members:
2 changes: 2 additions & 0 deletions _sources/api/plugin/system__template.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. automodule:: moa.plugin.system.template
:members:
2 changes: 2 additions & 0 deletions _sources/api/plugin/system__test.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. automodule:: moa.plugin.system.test
:members:
2 changes: 2 additions & 0 deletions _sources/api/plugin/system__umask.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. automodule:: moa.plugin.system.umask
:members:
2 changes: 2 additions & 0 deletions _sources/api/plugin/system__varInject.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. automodule:: moa.plugin.system.varInject
:members:
10 changes: 6 additions & 4 deletions _sources/install.txt
Original file line number Diff line number Diff line change
Expand Up @@ -76,11 +76,13 @@ and many more
Installing git (from github)
----------------------------

Moa is hosted on and can be installed from `github <http://github.com/mfiers/Moa>`_::
Moa is hosted on, and can be installed from, `github <http://github.com/mfiers/Moa>`_::

cd ~
git clone git://github.com/mfiers/Moa.git moa

Note - their is also a copy of moa in the python package index - this
one is almost certainly outdated, and is currently not supported.

Configuration
-------------
Expand Down Expand Up @@ -108,9 +110,9 @@ are a few options that you can pursue:
Installing the web interface
----------------------------

Note - this is experimental - you will probably need to fiddle a
little with the configuration to get it working. Start with installing
apache2.
Note - this is highly experimental - you will probably need to fiddle
with the configuration files to get it working. Start with installing
apache2.

Then - assuming that:
* Your Moa work directory is under /home/moa/work
Expand Down
Binary file modified _static/MoaManual.pdf
Binary file not shown.
7 changes: 7 additions & 0 deletions add_all_to_repo.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
git add _sources/api/plugin/*.txt
git add _sources/api/*.txt
git add _sources/*.txt
git add _sources/templates/*.txt
git add _static/*
git add api/plugin/*html
git add templates/*.html
6 changes: 3 additions & 3 deletions api/Yaco.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<link rel="top" title="Moa 0.11.0 documentation" href="../index.html" />
<link rel="up" title="Moa API" href="index.html" />
<link rel="next" title="fist" href="fist.html" />
<link rel="prev" title="&lt;no title&gt;" href="plugin/varInject.html" />
<link rel="prev" title="varInject - Inject variables into this job" href="plugin/system__varInject.html" />
</head>
<body>
<div class="related">
Expand All @@ -43,7 +43,7 @@ <h3>Navigation</h3>
<a href="fist.html" title="fist"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="plugin/varInject.html" title="&lt;no title&gt;"
<a href="plugin/system__varInject.html" title="varInject - Inject variables into this job"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">Moa 0.11.0 documentation</a> &raquo;</li>
<li><a href="index.html" accesskey="U">Moa API</a> &raquo;</li>
Expand Down Expand Up @@ -274,7 +274,7 @@ <h3>Navigation</h3>
<a href="fist.html" title="fist"
>next</a> |</li>
<li class="right" >
<a href="plugin/varInject.html" title="&lt;no title&gt;"
<a href="plugin/system__varInject.html" title="varInject - Inject variables into this job"
>previous</a> |</li>
<li><a href="../index.html">Moa 0.11.0 documentation</a> &raquo;</li>
<li><a href="index.html" >Moa API</a> &raquo;</li>
Expand Down
20 changes: 19 additions & 1 deletion api/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,25 @@ <h1>Moa API<a class="headerlink" href="#moa-api" title="Permalink to this headli
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="plugin/index.html">moa.plugin</a><ul>
<li class="toctree-l2"><a class="reference internal" href="plugin/adhoc.html"><strong>adhoc</strong> - create jobs from adhoc bash code</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/job__metavar.html"><strong>metavar</strong> - Create a number of meta variables</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/system__adhoc.html"><strong>adhoc</strong> - create jobs from adhoc bash code</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/system__configure.html"><strong>configure</strong> - Configure jobs</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/system__doc.html"><strong>doc</strong> - Manage job documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/system__extraCommands.html"><strong>extraCommands</strong> - Pre &amp; Post commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/system__fileset.html"><strong>fileset</strong> - define sets of in&amp;output files</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/system__help.html"><strong>help</strong> - generate help</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/system__info.html"><strong>info</strong> - Job information</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/system__lock.html"><strong>lock</strong> - Lock/Unlock moa jobs</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/system__logger.html"><strong>logger</strong> - Log Moa activity</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/system__moautil.html"><strong>moautil</strong> - Some extra utilities - copy/move jobs</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/system__newjob.html"><strong>newjob</strong> - Instantiate new jobs</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/system__parameterCheck.html"><strong>parameterCheck</strong> - check parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/system__project.html"><strong>project</strong> - Simple plugin to ease maintaining project data</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/system__status.html"><strong>status</strong> - Job Status</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/system__template.html"><strong>template</strong> - information on templates</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/system__test.html"><strong>test</strong> - Run unittests</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/system__umask.html"><strong>umaks</strong> - Sets umaks for the moa process</a></li>
<li class="toctree-l2"><a class="reference internal" href="plugin/system__varInject.html"><strong>varInject</strong> - Inject variables into this job</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="Yaco.html">Yaco</a><ul>
Expand Down
30 changes: 24 additions & 6 deletions api/plugin/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
<script type="text/javascript" src="../../_static/doctools.js"></script>
<link rel="top" title="Moa 0.11.0 documentation" href="../../index.html" />
<link rel="up" title="Moa API" href="../index.html" />
<link rel="next" title="adhoc - create jobs from adhoc bash code" href="adhoc.html" />
<link rel="next" title="metavar - Create a number of meta variables" href="job__metavar.html" />
<link rel="prev" title="Ruff" href="../backend/ruff.html" />
</head>
<body>
Expand All @@ -40,7 +40,7 @@ <h3>Navigation</h3>
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="adhoc.html" title="adhoc - create jobs from adhoc bash code"
<a href="job__metavar.html" title="metavar - Create a number of meta variables"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="../backend/ruff.html" title="Ruff"
Expand All @@ -59,7 +59,25 @@ <h3>Navigation</h3>
<h1>moa.plugin<a class="headerlink" href="#moa-plugin" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="adhoc.html"><strong>adhoc</strong> - create jobs from adhoc bash code</a></li>
<li class="toctree-l1"><a class="reference internal" href="job__metavar.html"><strong>metavar</strong> - Create a number of meta variables</a></li>
<li class="toctree-l1"><a class="reference internal" href="system__adhoc.html"><strong>adhoc</strong> - create jobs from adhoc bash code</a></li>
<li class="toctree-l1"><a class="reference internal" href="system__configure.html"><strong>configure</strong> - Configure jobs</a></li>
<li class="toctree-l1"><a class="reference internal" href="system__doc.html"><strong>doc</strong> - Manage job documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="system__extraCommands.html"><strong>extraCommands</strong> - Pre &amp; Post commands</a></li>
<li class="toctree-l1"><a class="reference internal" href="system__fileset.html"><strong>fileset</strong> - define sets of in&amp;output files</a></li>
<li class="toctree-l1"><a class="reference internal" href="system__help.html"><strong>help</strong> - generate help</a></li>
<li class="toctree-l1"><a class="reference internal" href="system__info.html"><strong>info</strong> - Job information</a></li>
<li class="toctree-l1"><a class="reference internal" href="system__lock.html"><strong>lock</strong> - Lock/Unlock moa jobs</a></li>
<li class="toctree-l1"><a class="reference internal" href="system__logger.html"><strong>logger</strong> - Log Moa activity</a></li>
<li class="toctree-l1"><a class="reference internal" href="system__moautil.html"><strong>moautil</strong> - Some extra utilities - copy/move jobs</a></li>
<li class="toctree-l1"><a class="reference internal" href="system__newjob.html"><strong>newjob</strong> - Instantiate new jobs</a></li>
<li class="toctree-l1"><a class="reference internal" href="system__parameterCheck.html"><strong>parameterCheck</strong> - check parameters</a></li>
<li class="toctree-l1"><a class="reference internal" href="system__project.html"><strong>project</strong> - Simple plugin to ease maintaining project data</a></li>
<li class="toctree-l1"><a class="reference internal" href="system__status.html"><strong>status</strong> - Job Status</a></li>
<li class="toctree-l1"><a class="reference internal" href="system__template.html"><strong>template</strong> - information on templates</a></li>
<li class="toctree-l1"><a class="reference internal" href="system__test.html"><strong>test</strong> - Run unittests</a></li>
<li class="toctree-l1"><a class="reference internal" href="system__umask.html"><strong>umaks</strong> - Sets umaks for the moa process</a></li>
<li class="toctree-l1"><a class="reference internal" href="system__varInject.html"><strong>varInject</strong> - Inject variables into this job</a></li>
</ul>
</div>
</div>
Expand All @@ -77,8 +95,8 @@ <h4>Previous topic</h4>
<p class="topless"><a href="../backend/ruff.html"
title="previous chapter">Ruff</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="adhoc.html"
title="next chapter"><strong>adhoc</strong> - create jobs from adhoc bash code</a></p>
<p class="topless"><a href="job__metavar.html"
title="next chapter"><strong>metavar</strong> - Create a number of meta variables</a></p>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../../search.html" method="get">
Expand Down Expand Up @@ -106,7 +124,7 @@ <h3>Navigation</h3>
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="adhoc.html" title="adhoc - create jobs from adhoc bash code"
<a href="job__metavar.html" title="metavar - Create a number of meta variables"
>next</a> |</li>
<li class="right" >
<a href="../backend/ruff.html" title="Ruff"
Expand Down

0 comments on commit 957fc90

Please sign in to comment.