Changeset 1298 for trunk/sphinxdocs/source/imports.rst

Timestamp:

Apr 23, 2014 5:11:13 PM (9 years ago)

Author:

toby

Message:

Start on parametric fitting; Time for new manual; fix minor formatting

File:

• trunk/sphinxdocs/source/imports.rst (modified) (5 diffs)

trunk/sphinxdocs/source/imports.rst

@@ -8 +8 @@
 to implement import of 
 a phase, a single crystal or a powder dataset, respectively. 
-Module file names (`G2phase_`, `G2pwd_` and `G2sfact_`) are used to
+Module file names (`G2phase_`, `G2pwd_` and `G2sfact_`, etc.) are used to
 determine which menu an import routine should be placed into. (N.B. this
 was an unnecessary choice; this could be done from the class used.)
+
+This list may not include all currently defined formats, since modules
+may be loaded from anywhere in the path. 
 
 Writing an Import Routine
@@ -169 +172 @@
 to give the user information on what went wrong during the reading.
 
-Currently Defined Phase Import Routines
+Phase Import Routines
 ----------------------------------------
 Phase import routines are classes derived from
@@ -190 +193 @@
     :synopsis: Reads phase information from a CIF
 
-Currently Defined Powder Data Import Routines
+Powder Data Import Routines
 ---------------------------------------------
 Powder data import routines are classes derived from
@@ -214 +217 @@
     :synopsis: Reads powder data from a CIF
 
-Currently Defined Single Crystal Data Import Routines
+Single Crystal Data Import Routines
 -----------------------------------------------------
 Single crystal data import routines are classes derived from
@@ -229 +232 @@
     :members: 
     :synopsis: Reads single crystal data from CIF files
+
+
+Small Angle Scattering Data Import Routines
+-----------------------------------------------------
+Small angle scattering data import routines are classes derived from
+, :class:`GSASIIIO.ImportSmallAngle`.
+They must be found in files named `G2sad*.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:: G2sad_xye
+    :members: 
+    :synopsis: Reads small angle scattering data from simple files