API doc updates

sphinx/source/conf.py

@@ -49,7 +49,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'APS Data Management'
-copyright = u'2017, APS/SDM'
+copyright = u'2015-2019, Argonne National Laboratory'
 author = u'APS/SDM'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -85,7 +85,8 @@ todo_include_todos = False
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+#html_theme = 'alabaster'
+html_theme = "sphinx_rtd_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

sphinx/source/dm.aps_bss.api.rst

-.. automodule:: dm.aps_bss.api
-
-.. currentmodule:: dm.aps_bss.api
-
-ApsBssApi
----------
-
-.. autoclass:: dm.aps_bss.api.apsBssApi.ApsBssApi()
-    :show-inheritance: 
-    :members:  __init__, listRuns, getCurrentRun, listBeamlineProposals, getBeamlineProposal
-
-

sphinx/source/dm.aps_db_web_service.api.rst

+.. automodule:: dm.aps_db_web_service.api
+
+.. currentmodule:: dm.aps_db_web_service.api
+
+ApsDbApiFactory
+---------------
+
+.. autoclass:: dm.aps_db_web_service.api.apsDbApiFactory.ApsDbApiFactory()
+    :show-inheritance:
+    :members: getBssApsDbApi, getEsafApsDbApi, getServiceMonitorApsDbApi
+
+BssApsDbApi
+-----------
+
+.. autoclass:: dm.aps_db_web_service.api.bssApsDbApi.BssApsDbApi()
+    :show-inheritance: 
+    :members:  __init__, listRuns, listBeamlines, getCurrentRun, listProposals, getProposal
+
+EsafApsDbApi
+------------
+
+.. autoclass:: dm.aps_db_web_service.api.esafApsDbApi.EsafApsDbApi()
+    :show-inheritance: 
+    :members:  __init__, listEsafs, getEsaf
+
+ServiceMonitorApsDbApi
+----------------------
+
+.. autoclass:: dm.aps_db_web_service.api.serviceMonitorApsDbApi.ServiceMonitorApsDbApi()
+    :show-inheritance:
+    :members: __init__, getServiceStatus, clearServiceStatus
+
+

sphinx/source/dm.cat_web_service.api.rst

+.. automodule:: dm.cat_web_service.api
+
+.. currentmodule:: dm.cat_web_service.api
+
+CatApiFactory
+-------------
+
+.. autoclass:: dm.cat_web_service.api.catApiFactory.CatApiFactory()
+    :show-inheritance:
+    :members: getDatasetCatApi, getFileCatApi, getServiceMonitorCatApi
+
+DatasetCatApi
+-------------
+
+.. autoclass:: dm.cat_web_service.api.datasetCatApi.DatasetCatApi()
+    :show-inheritance:
+    :members: __init__, addExperimentDataset, updateExperimentDataset, updateDatasetById, getDatasets, getExperimentDatasets, getDatasetById, getExperimentDataset, getExperimentDatasetFiles
+
+FileCatApi
+----------
+
+.. autoclass:: dm.cat_web_service.api.fileCatApi.FileCatApi()
+    :show-inheritance:
+    :members: __init__, addExperimentFile, updateExperimentFile, updateExperimentFileById, updateExperimentFiles, updateExperimentFilesAsync, getAsyncUpdateStatus, getExperimentFiles, getExperimentFileById, getExperimentFile, deleteExperimentFile, deleteExperimentFileById, getExperimentFileCollectionStats, renameExperimentFileCollection, deleteExperimentFileCollection
+
+ServiceMonitorCatApi
+--------------------
+
+.. autoclass:: dm.cat_web_service.api.serviceMonitorCatApi.ServiceMonitorCatApi()
+    :show-inheritance:
+    :members: __init__, getServiceStatus, clearServiceStatus
+

sphinx/source/dm.common.api.rst

+.. automodule:: dm.common.api
+
+.. currentmodule:: dm.common.api
+
+DmApiFactory
+--------------
+
+.. autoclass:: dm.common.api.dmApiFactory.DmApiFactory()
+    :show-inheritance: 
+    :members: USERNAME_KEY, PASSWORD_KEY, PASSWORD_FILE_KEY, LOGIN_FILE_KEY, HOST_KEY, PORT_KEY, PROTOCOL_KEY, setDefaults, setConfigFile, getConfiguration 
+
+

sphinx/source/dm.daq_web_service.api.rst

@@ -2,6 +2,13 @@
 
 .. currentmodule:: dm.daq_web_service.api
 
+DaqApiFactory
+-------------
+
+.. autoclass:: dm.daq_web_service.api.daqApiFactory.DaqApiFactory()
+    :show-inheritance:
+    :members: getExperimentDaqApi, getServiceMonitorDaqApi
+
 ExperimentDaqApi
 -----------------
 
@@ -9,4 +16,11 @@ ExperimentDaqApi
     :show-inheritance: 
     :members:  __init__, startDaq, stopDaq, listDaqs, getDaqInfo, clearDaq, upload, stopUpload, listUploads, getUploadInfo, clearUpload, listProcessingPlugins
 
+ServiceMonitorDaqApi
+--------------------
+
+.. autoclass:: dm.daq_web_service.api.serviceMonitorDaqApi.ServiceMonitorDaqApi()
+    :show-inheritance:
+    :members:  __init__, getServiceStatus, clearServiceStatus
+
 

sphinx/source/dm.ds_web_service.api.rst

@@ -2,11 +2,53 @@
 
 .. currentmodule:: dm.ds_web_service.api
 
+DsApiFactory
+-------------
+
+.. autoclass:: dm.ds_web_service.api.dsApiFactory.DsApiFactory()
+    :show-inheritance:
+    :members: getUserDsApi, getAuthDsApi, getExperimentDsApi, getFileDsApi, getEsafDsApi, getServiceMonitorDsApi
+
+AuthDsApi
+---------
+
+.. autoclass:: dm.ds_web_service.api.authDsApi.AuthDsApi()
+    :show-inheritance: 
+    :members:  __init__, addSession, checkSession, getAuthorizationPrincipal
+
+EsafDsApi
+---------
+
+.. autoclass:: dm.ds_web_service.api.esafDsApi.EsafDsApi()
+    :show-inheritance: 
+    :members:  __init__, getSectorEsafsByYear, getEsafById
+
+FileDsApi
+---------
+
+.. autoclass:: dm.ds_web_service.api.fileDsApi.FileDsApi()
+    :show-inheritance: 
+    :members:  __init__, processFile, compressFile, decompressFile, deleteFile, statFile, processDirectory, download
+
 ExperimentDsApi
------------------
+---------------
 
 .. autoclass:: dm.ds_web_service.api.experimentDsApi.ExperimentDsApi()
     :show-inheritance: 
     :members:  __init__, getExperimentTypes, getExperiments, getExperimentsByStation, getExperimentByName, getExperimentById, addExperiment, updateExperiment, deleteExperimentById, deleteExperimentByName
 
+ServiceMonitorDsApi
+--------------------
+
+.. autoclass:: dm.ds_web_service.api.serviceMonitorDsApi.ServiceMonitorDsApi()
+    :show-inheritance:
+    :members:  __init__, getServiceStatus, clearServiceStatus
+
+UserDsApi
+---------
+
+.. autoclass:: dm.ds_web_service.api.userDsApi.UserDsApi()
+    :show-inheritance: 
+    :members:  __init__, getUsers, getUserById, getUserByUsername, addUserSystemRole, deleteUserSystemRole, addUserExperimentRole, deleteUserExperimentRole
+
 

sphinx/source/dm.proc_web_service.api.rst

+.. automodule:: dm.proc_web_service.api
+
+.. currentmodule:: dm.proc_web_service.api
+
+ProcApiFactory
+--------------
+
+.. autoclass:: dm.proc_web_service.api.procApiFactory.ProcApiFactory()
+    :show-inheritance: 
+    :members: getServiceMonitorProcApi, getWorkflowProcApi 
+
+ServiceMonitorProcApi
+---------------------
+
+.. autoclass:: dm.proc_web_service.api.serviceMonitorProcApi.ServiceMonitorProcApi()
+    :show-inheritance: 
+    :members:  __init__, getServiceStatus, clearServiceStatus
+
+WorkflowProcApi
+---------------
+
+.. autoclass:: dm.proc_web_service.api.workflowProcApi.WorkflowProcApi()
+    :show-inheritance: 
+    :members:  __init__, listWorkflows, addWorkflow, getWorkflowById, getWorkflowByName, updateWorkflow, deleteWorkflowByName, listProcessingJobs, startProcessingJob, getProcessingJobById
+

sphinx/source/index.rst

@@ -12,9 +12,12 @@ The `dm` package contains python APIs for accessing Data Management services.
    :maxdepth: 4
    :caption: Contents:
 
-   dm.ds_web_service.api
+   dm.common.api
+   dm.aps_db_web_service.api
+   dm.cat_web_service.api
    dm.daq_web_service.api
-   dm.aps_bss.api
+   dm.ds_web_service.api
+   dm.proc_web_service.api
 
 Indices and tables
 ==================