Changeset 3823

Timestamp:

Feb 13, 2019 5:43:05 PM (5 years ago)

Author:

toby

Message:

attempt to fix more broken doc references

Location:

trunk

Files:

• GSASIIobj.py (modified) (9 diffs)
• docs/source/imports.rst (modified) (2 diffs)

trunk/GSASIIobj.py

@@ -2025 +2025 @@
 
     Objects constructed that subclass this (in import/G2phase_*.py etc.) will be used
-    in :meth:`GSASIIdataGUI.GSASII.OnImportPhase`.
-    See :ref:`Writing a Import Routine<Import_Routines>`
+    in :meth:`GSASIIdataGUI.GSASII.OnImportPhase` and in 
+    :func:`GSASIIscriptable.import_generic`.
+    See :ref:`Writing a Import Routine<import_routines>`
     for an explanation on how to use this class.
 
@@ -2048 +2049 @@
     :meth:`Reader`.
 
-    See :ref:`Writing a Import Routine<Import_Routines>`
+    See :ref:`Writing a Import Routine<import_routines>`
     for an explanation on how to use import classes in general. The specifics
     for reading a structure factor histogram require that
@@ -2103 +2104 @@
 
     Objects constructed that subclass this (in import/G2pwd_*.py etc.) will be used
-    in :meth:`GSASIIdataGUI.GSASII.OnImportPowder`.
-    See :ref:`Writing a Import Routine<Import_Routines>`
+    in :meth:`GSASIIdataGUI.GSASII.OnImportPowder` and in 
+    :func:`GSASIIscriptable.import_generic`.
+    See :ref:`Writing a Import Routine<import_routines>`
     for an explanation on how to use this class.
     '''
@@ -2146 +2148 @@
 class ImportSmallAngleData(ImportBaseclass):
     '''Defines a base class for the reading of files with small angle data.
-    See :ref:`Writing a Import Routine<Import_Routines>`
+    See :ref:`Writing a Import Routine<import_routines>`
     for an explanation on how to use this class.
     '''
@@ -2180 +2182 @@
 class ImportReflectometryData(ImportBaseclass):
     '''Defines a base class for the reading of files with reflectometry data.
-    See :ref:`Writing a Import Routine<Import_Routines>`
+    See :ref:`Writing a Import Routine<import_routines>`
     for an explanation on how to use this class.
     '''
@@ -2214 +2216 @@
 class ImportPDFData(ImportBaseclass):
     '''Defines a base class for the reading of files with PDF G(R) data.
-    See :ref:`Writing a Import Routine<Import_Routines>`
+    See :ref:`Writing a Import Routine<import_routines>`
     for an explanation on how to use this class.
     '''
@@ -2248 +2250 @@
         methods :meth:`ExtensionValidator`, :meth:`ContentsValidator` and
         :meth:`Reader`. This returns a list of reader objects for each read image.
+        Also used in :func:`GSASIIscriptable.import_generic`.
 
       * Images are read alternatively in :func:`GSASIIIO.ReadImages`, which puts image info
@@ -2253 +2256 @@
 
       * Images are reloaded with :func:`GSASIIIO.GetImageData`.
-
-    .. _Image_import_routines:
 
     When reading an image, the ``Reader()`` routine in the ImportImage class
@@ -2281 +2282 @@
 
     Note that the above is initialized with :meth:`InitParameters`.
-    (Also see :ref:`Writing a Import Routine<Import_Routines>`
+    (Also see :ref:`Writing a Import Routine<import_routines>`
     for an explanation on how to use import classes in general.)
     '''

trunk/docs/source/imports.rst

@@ -155 +155 @@
 in a file. 
 
+.. _ContentsValidator:  
+
 ContentsValidator()
 ~~~~~~~~~~~~~~~~~~~~
-
-.. _ContentsValidator:
 
 Defining a ``ContentsValidator`` method is optional, but is usually a
@@ -301 +301 @@
 Image import routines are classes derived from
 :class:`GSASIIIO.ImportImage`. 
-See :ref:`Writing a Import Routine<Import_Routines>` for general
-information on importers and 
-:ref:`the ImportImage docstring<Image_import_routines>`
-for what a reader should define. 
+See :ref:`Writing a Import Routine<import_routines>` for general
+information on importers and the :class:`GSASIIobj.ImportImage` for
+information on what class variables a reader should set. 
 Image importers 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