Pgen docs (#275)

* Initial pgen docs with itertools example * Add pargs example * Add pgen using numpy plus helper function for 1D distribution * Fix typos, update image * Initial port of complete Parameters documentation * Fix up api docs warnings, add missing script adapters * Add subsection on accessing env block variables inside pgen * Literal imports and some style tweaks. * Some minor title and header tweaks. * Remove out of date notes * Renamed itertools_pgen to reference LULESH. * Update doc strings on parameter generator samples * Make flake8 happy * Misc cleanup and formatting, adding more links and internal references * Fix up section listing, in-text moniker/function formatting Co-authored-by: Frank Di Natale <[email protected]>
LLNL · May 27, 2020 · 2998cc4 · 2998cc4
1 parent 4d65e76
commit 2998cc4
Show file tree

Hide file tree

Showing 17 changed files with 558 additions and 63 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -14,6 +14,7 @@ Welcome to Maestro Workflow Conductor Documentation
    quick_start
    hello_world
    lulesh_breakdown
+   parameters
    maestro_core
 
    modules

diff --git a/docs/source/maestrowf.abstracts.rst b/docs/source/maestrowf.abstracts.rst
@@ -41,14 +41,6 @@ maestrowf.abstracts.graph module
     :undoc-members:
     :show-inheritance:
 
-maestrowf.abstracts.simobject module
-------------------------------------
-
-.. automodule:: maestrowf.abstracts.simobject
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 maestrowf.abstracts.specification module
 ----------------------------------------
 

diff --git a/docs/source/maestrowf.interfaces.script.rst b/docs/source/maestrowf.interfaces.script.rst
@@ -25,4 +25,20 @@ maestrowf.interfaces.script.slurmscriptadapter module
     :undoc-members:
     :show-inheritance:
 
+maestrowf.interfaces.script.lsfscriptadapter module
+-----------------------------------------------------
+
+.. automodule:: maestrowf.interfaces.script.lsfscriptadapter
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+maestrowf.interfaces.script.fluxscriptadapter module
+-----------------------------------------------------
+
+.. automodule:: maestrowf.interfaces.script.fluxscriptadapter
+    :members:
+    :undoc-members:
+    :show-inheritance:       
+