docs

prjemian · Jun 17, 2016 · e7fb918 · e7fb918
1 parent 8768975
commit e7fb918
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 10 deletions.
diff --git a/docs/source/plugin.rst b/docs/source/plugin.rst
@@ -27,8 +27,10 @@ These plugin modules are supplied:
    :nosignatures:
 
    ~spec2nexus.plugins.spec_common_spec2nexus
+   ~spec2nexus.plugins.fallback_spec2nexus
    ~spec2nexus.plugins.unicat_spec2nexus
    ~spec2nexus.plugins.uim_spec2nexus
+   ~spec2nexus.plugins.XPCS_spec2nexus
 
 .. toctree::
    :maxdepth: 2
@@ -86,9 +88,13 @@ Plugins for these control lines [#]_ are provided in **spec2nexus**:
    ~spec2nexus.plugins.spec_common_spec2nexus.SPEC_MCA_ChannelInformation
    ~spec2nexus.plugins.spec_common_spec2nexus.SPEC_MCA_CountTime
    ~spec2nexus.plugins.spec_common_spec2nexus.SPEC_MCA_RegionOfInterest
+   ~spec2nexus.plugins.fallback_spec2nexus.UnrecognizedControlLine
    ~spec2nexus.plugins.unicat_spec2nexus.UNICAT_MetadataMnemonics
    ~spec2nexus.plugins.unicat_spec2nexus.UNICAT_MetadataValues
    ~spec2nexus.plugins.uim_spec2nexus.UIM_generic
+   ~spec2nexus.plugins.XPCS_spec2nexus.XPCS_VA
+   ~spec2nexus.plugins.XPCS_spec2nexus.XPCS_VD
+   ~spec2nexus.plugins.XPCS_spec2nexus.XPCS_VE
 
 .. [#] Compare this list with :ref:`plugin_list`
 

diff --git a/docs/source/supplied_plugins/XPCS_spec2nexus.rst b/docs/source/supplied_plugins/XPCS_spec2nexus.rst
@@ -0,0 +1,9 @@
+
+.. _XPCS_spec2nexus:
+
+XPCS plugin
+###########
+
+.. automodule:: spec2nexus.plugins.XPCS_spec2nexus
+    :members: 
+    :synopsis: SPEC data file control lines unique to the APS XPCS instrument
diff --git a/docs/source/supplied_plugins/fallback_spec2nexus.rst b/docs/source/supplied_plugins/fallback_spec2nexus.rst
@@ -0,0 +1,9 @@
+
+.. _fallback_spec2nexus:
+
+Fallback plugin
+###############
+
+.. automodule:: spec2nexus.plugins.fallback_spec2nexus
+    :members: 
+    :synopsis: Fallback handling for any SPEC data file control lines not recognized by other handlers.
diff --git a/src/spec2nexus/specplot.py b/src/spec2nexus/specplot.py
@@ -63,16 +63,16 @@ class MacroPlotHandler(object):
     ========================== ==================================================
     method                     returns (as a string)
     ========================== ==================================================
-    :ref:`~get_data_file_name` the name of the file with the actual data
-    :ref:`~get_plot_data`      retrieve default data from spec data file
-    :ref:`~get_macro`          the name of the SPEC scan macro used
-    :ref:`~get_plot_title`     the name for the top of the plot
-    :ref:`~get_plot_subtitle`  optional smaller text below the title
-    :ref:`~get_x_title`        text for the independent (horizontal) axis
-    :ref:`~get_y_title`        text for the dependent (vertical) axis
-    :ref:`~get_x_log`          True: axis is logarithmic, False: axis is linear
-    :ref:`~get_y_log`          True: axis is logarithmic, False: axis is linear
-    :ref:`~get_timestamp_str`  text representing when the scan was recorded
+    :meth:`get_data_file_name` the name of the file with the actual data
+    :meth:`get_plot_data`      retrieve default data from spec data file
+    :meth:`get_macro`          the name of the SPEC scan macro used
+    :meth:`get_plot_title`     the name for the top of the plot
+    :meth:`get_plot_subtitle`  optional smaller text below the title
+    :meth:`get_x_title`        text for the independent (horizontal) axis
+    :meth:`get_y_title`        text for the dependent (vertical) axis
+    :meth:`get_x_log`          True: axis is logarithmic, False: axis is linear
+    :meth:`get_y_log`          True: axis is logarithmic, False: axis is linear
+    :meth:`get_timestamp_str`  text representing when the scan was recorded
     ========================== ==================================================
     '''