Merge pull request #431 from BCDA-APS/410-mocks

adjust Mocks for documentation
BCDA-APS · Sep 28, 2020 · 1711dca · 1711dca
2 parents 59c3145 + 2236193
commit 1711dca
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 41 deletions.
diff --git a/apstools/devices.py b/apstools/devices.py
@@ -58,36 +58,9 @@
     ~ShutterBase
     ~SimulatedApsPssShutterWithStatus
 
-synApps (and EPICS base) records
+synApps Support
 
-.. autosummary::
-
-    ~BusyRecord
-    ~BusyStatus
-    ~CalcoutRecord
-    ~CalcoutRecordChannel
-    ~EpidRecord
-    ~SaveData
-    ~SscanRecord
-    ~SscanDevice
-    ~SwaitRecord
-    ~SwaitRecordChannel
-    ~TransformRecord
-    ~UserCalcoutDevice
-    ~UserCalcsDevice
-    ~UserTransformsDevice
-
-synApps support
-
-.. autosummary::
-
-    ~setup_gaussian_calcout
-    ~setup_gaussian_swait
-    ~setup_incrementer_calcout
-    ~setup_incrementer_swait
-    ~setup_lorentzian_calcout
-    ~setup_lorentzian_swait
-    ~setup_random_number_swait
+    See separate :ref:`synApps` section.
 
 OTHER SUPPORT
 
@@ -2031,17 +2004,21 @@ class AD_EpicsJpegFileName(FileStorePluginBase):    # lgtm [py/missing-call-to-i
 
     """
     custom class to define image file name from EPICS
+
     .. caution:: *Caveat emptor* applies here.  You assume expertise!
+
     Replace standard Bluesky algorithm where file names
     are defined as UUID strings, virtually guaranteeing that
     no existing images files will ever be overwritten.
     Also, this method decouples the data files from the databroker,
     which needs the files to be named by UUID.
+
     .. autosummary::
         ~make_filename
         ~generate_datum
         ~get_frames_per_point
         ~stage
+
     Patterned on ``apstools.devices.AD_EpicsHdf5FileName()``.
     (Follow that documentation from this point.)
     """

diff --git a/apstools/utils.py b/apstools/utils.py
@@ -720,6 +720,9 @@ def show_ophyd_symbols(show_pv=True,
                        printing=True,
                        verbose=False,
                        symbols=None):
+    """
+    DEPRECATED: Use listobjects() instead.
+    """
     warnings.warn(
         "DEPRECATED: show_ophyd_symbols() will be removed"
         " in a future release.  Use listobjects() instead."

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -168,18 +168,15 @@
      'Miscellaneous'),
 ]
 
-
-
 # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
 
 # http://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_mock_imports
-autodoc_mock_imports = """
-    bluesky
-    databroker
-    h5py
-    matplotlib
-    numpy
-    ophyd
-    pandas
-    pyRestTable
-    """.split()
+autodoc_mock_imports = [
+    'h5py',
+    'matplotlib',
+    'networkx',
+    'pandas',
+    'pyRestTable',
+    'snapshot',
+    'xarray',
+    ]