Permalink
Browse files

bigjob 'manual' updates

  • Loading branch information...
1 parent cf0be7e commit cf567acb180ee1a043ed4eb9723824ba5f6af990 @oleweidner oleweidner committed Dec 15, 2012
Showing with 26 additions and 1 deletion.
  1. +22 −0 docs/README
  2. +4 −1 docs/source/library/index.rst
View
@@ -0,0 +1,22 @@
+Generating the documentation:
+
+Install BigJob from sources, i.e., in BigJob source root::
+
+ virtualenv /tmp/BJ/
+ source /tmp/BJ/bin/activate
+ easy_install .
+
+Next install Sphinx in the virtualenv::
+
+ pip install sphinx
+
+Change to the docs directory.
+
+ * make html creates the HTML documentation in build/html
+ * make latexpdf creates the PDF manual in build/latex
+
+
+
+
+
+
@@ -5,6 +5,9 @@ Library Reference
Compute and Data Services
*************************
+Some propper discussion what compute and data services are and how they are supposed to
+be used needs to go here. The 'aggregate' ComputeDataService needs to be explained here
+as well! And examples! Examples are always good.
.. autoclass:: pilot.impl.pilotcompute_manager.PilotComputeService
:members:
@@ -13,4 +16,4 @@ Compute and Data Services
:members:
.. autoclass:: pilot.impl.pilot_manager.ComputeDataService
- :members:
+ :members:

0 comments on commit cf567ac

Please sign in to comment.