Changeset 2010 for sphinxdocs/source

Timestamp:

Oct 16, 2015 11:13:04 AM (8 years ago)

Author:

toby

Message:

update docs

Location:

sphinxdocs/source

Files:

• exports.rst (modified) (2 diffs)
• imports.rst (modified) (2 diffs)

sphinxdocs/source/exports.rst

@@ -7 +7 @@
 ('project', 'phase', 'single', 'powder', 'image', 'map' or (someday)
 'pdf') and of ``self.multiple``
-determines if only a single phase, data set, etc. can be exported at a time (when False) or more than one can be selected.
+determines if only a single phase, data set, etc. can be exported at a
+time (when False) or more than one can be selected.
+
+Powder export routines may optionally define a ``Writer()``
+method that accepts the histogram tree name as well as a file name to
+be written. This allows :func:`ExportPowder` to use the exporter
+independent of the GUI. 
 
 .. automodule:: G2export_examples
@@ -42 +48 @@
     :members: 
     :synopsis: Export powder data in GSAS and Topas formats
+
+.. automodule:: G2export_FIT2D 
+    :members: 
+    :synopsis: Export powder data in Fit2D (.chi) format
+       

sphinxdocs/source/imports.rst

@@ -198 +198 @@
 :class:`GSASIIIO.ImportPowderData`. 
 They must be found in files named `G2pwd*.py` that are in the Python path
-and the class must override the ``__init__`` method and add a ``Reader`` method.
+and the class must override the ``__init__`` method and add a
+``Reader`` method. 
+
 The distributed routines are:
 
@@ -245 +247 @@
     :members: 
     :synopsis: Reads small angle scattering data from simple files
+
+Image Import Routines
+-----------------------------------------------------
+Image import routines are classes derived from
+, :class:`GSASIIIO.ImportImage`.
+They must be found in files named `G2img*.py` that are in the Python path
+and the class must override the ``__init__`` method and add a ``Reader`` method.
+The distributed routines are:
+
+.. automodule:: G2img_ADSC
+    :members: 
+
+.. automodule:: G2img_EDF
+    :members: 
+
+.. automodule:: G2img_SumG2
+    :members: 
+
+.. automodule:: G2img_GE
+    :members: 
+
+.. automodule:: G2img_MAR
+    :members: 
+
+.. automodule:: G2img_Rigaku
+    :members: 
+
+.. automodule:: G2img_1TIF
+    :members: 
+
+.. automodule:: G2img_CheMin
+    :members: