Merge pull request #37 from njzjz/docs

update API document
deepmodeling · Jun 3, 2021 · d3476ff · d3476ff
2 parents 7cd1d67 + b8a6d33
commit d3476ff
Showing 1 changed file with 46 additions and 13 deletions.
diff --git a/doc/api.rst b/doc/api.rst
@@ -5,54 +5,87 @@ DPDispatcher API
    :maxdepth: 2
    :caption: Contents:
 
-.. automodule:: dpdispatcher.ALI
+.. automodule:: dpdispatcher
    :members:
    :undoc-members:
 
-.. automodule:: dpdispatcher.AWS
+.. automodule:: dpdispatcher.JobStatus
    :members:
    :undoc-members:
 
-.. automodule:: dpdispatcher.Batch
+.. automodule:: dpdispatcher.base_context
    :members:
    :undoc-members:
 
-.. automodule:: dpdispatcher.Dispatcher
+.. automodule:: dpdispatcher.dp_cloud_server
    :members:
    :undoc-members:
 
-.. automodule:: dpdispatcher.DispatcherList
+.. automodule:: dpdispatcher.dp_cloud_server_context
    :members:
    :undoc-members:
 
-.. automodule:: dpdispatcher.JobStatus
+.. automodule:: dpdispatcher.dpdisp
+   :members:
+   :undoc-members:
+
+.. automodule:: dpdispatcher.lazy_local_context
+   :members:
+   :undoc-members:
+
+.. automodule:: dpdispatcher.local_context
+   :members:
+   :undoc-members:
+
+.. automodule:: dpdispatcher.lsf
+   :members:
+   :undoc-members:
+
+.. automodule:: dpdispatcher.machine
    :members:
    :undoc-members:
 
-.. automodule:: dpdispatcher.LSF
+.. automodule:: dpdispatcher.pbs
    :members:
    :undoc-members:
 
-.. automodule:: dpdispatcher.LazyLocalContext
+.. automodule:: dpdispatcher.shell
    :members:
    :undoc-members:
 
-.. automodule:: dpdispatcher.LocalContext
+.. automodule:: dpdispatcher.slurm
    :members:
    :undoc-members:
 
-.. automodule:: dpdispatcher.PBS
+.. automodule:: dpdispatcher.ssh_context
    :members:
    :undoc-members:
 
-.. automodule:: dpdispatcher.SSHContext
+.. automodule:: dpdispatcher.submission
    :members:
    :undoc-members:
 
-.. automodule:: dpdispatcher.Shell
+.. automodule:: dpdispatcher.dpcloudserver
    :members:
    :undoc-members:
 
-.. automodule:: dpdispatcher.Slurm
+.. automodule:: dpdispatcher.dpcloudserver.api
    :members:
    :undoc-members:
+
+.. automodule:: dpdispatcher.dpcloudserver.config
+   :members:
+   :undoc-members:
+
+.. automodule:: dpdispatcher.dpcloudserver.retcode
+   :members:
+   :undoc-members:
+
+.. automodule:: dpdispatcher.dpcloudserver.temp_test
+   :members:
+   :undoc-members:
+
+.. automodule:: dpdispatcher.dpcloudserver.zip_file
+   :members:
+   :undoc-members:
+