diff --git a/RELEASE_NOTES.txt b/RELEASE_NOTES.txt index 175db19f5ad3c9d63ea8abecc3b1cc3eb66dd3e4..c48e1db6479028998f64b83b8626de08b15ce9d8 100644 --- a/RELEASE_NOTES.txt +++ b/RELEASE_NOTES.txt @@ -1,3 +1,17 @@ +Release 1.1 () +============================= + +- Added the following functionality for managing DAQs: + - Max. run time specification causes DAQ to be stopped automatically + - Target directory specification causes files to be uploaded into + a specific directory relative to experiment root path + - Upload data/target directory on exit specify upload of the given + directory automatically after DAQ completes +- Added the following functionality for managing uploads: + - Target directory specification causes files to be uploaded into + a specific directory relative to experiment root path +- Introduced sphinx as python API documentation framework + Release 1.0 (01/31/2017) ============================= diff --git a/sphinx/.svnignore b/sphinx/.svnignore new file mode 100644 index 0000000000000000000000000000000000000000..9ef96044faba86acfbf59bd0deb4545625df837f --- /dev/null +++ b/sphinx/.svnignore @@ -0,0 +1,2 @@ +build + diff --git a/sphinx/source/dm.aps_bss.api.rst b/sphinx/source/dm.aps_bss.api.rst new file mode 100644 index 0000000000000000000000000000000000000000..00946b37a6dbeaf1c387c384bfb6c322e01a6941 --- /dev/null +++ b/sphinx/source/dm.aps_bss.api.rst @@ -0,0 +1,12 @@ +.. 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 + + diff --git a/sphinx/source/index.rst b/sphinx/source/index.rst index d9d39b903dc1dcbabd6c744a2e340a89a62b73ab..d7220f53355315c8812f0e9bc38bea52a622de8b 100644 --- a/sphinx/source/index.rst +++ b/sphinx/source/index.rst @@ -13,6 +13,7 @@ The `dm` package contains python APIs for accessing Data Management services. :caption: Contents: dm.daq_web_service.api + dm.aps_bss.api Indices and tables ==================