try to fix autosummary & examples fix

jeffkinnison · Nov 10, 2020 · f05dafc · f05dafc
1 parent c330941
commit f05dafc
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 5 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -0,0 +1,13 @@
+.. autosummary::
+    :toctree: modules
+
+    shadho
+    shadho.configuration
+    shadho.hardware
+    shadho.installers
+    shadho.managers
+    shadho.scaling
+    shadho.shadho
+    shadho.spaces
+    shadho.utils
+    shadho.worker
diff --git a/docs/examples.rst b/docs/examples.rst
@@ -162,10 +162,6 @@ on each worker.
         opt.add_input_file('sin_task.sh')
         opt.add_input_file('sin.py')
 
-        # Optionally, provide a name for the Work Queue master that tracks the
-        # distributed workers.
-        opt.config.workqueue.name = 'shadho_sin_ex'
-
         # Run the search, and the optimal observed value will be output after 60s.
         opt.run()
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -15,7 +15,7 @@ SHADHO: Optimization Optimized
    spec
    ccs
    examples
-   reference
+   api
 
 SHADHO stands for **S**\ calable **H**\ ardware-\ **A**\ ware **D**\ istributed
 **H**\ yperparameter **O**\ ptimizer. All hardware is not created equal, and all

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1 +1,2 @@
 numpydoc
+pyrameter