Changeset 3823


Ignore:
Timestamp:
Feb 13, 2019 5:43:05 PM (3 years ago)
Author:
toby
Message:

attempt to fix more broken doc references

Location:
trunk
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/GSASIIobj.py

    r3822 r3823  
    20252025
    20262026    Objects constructed that subclass this (in import/G2phase_*.py etc.) will be used
    2027     in :meth:`GSASIIdataGUI.GSASII.OnImportPhase`.
    2028     See :ref:`Writing a Import Routine<Import_Routines>`
     2027    in :meth:`GSASIIdataGUI.GSASII.OnImportPhase` and in
     2028    :func:`GSASIIscriptable.import_generic`.
     2029    See :ref:`Writing a Import Routine<import_routines>`
    20292030    for an explanation on how to use this class.
    20302031
     
    20482049    :meth:`Reader`.
    20492050
    2050     See :ref:`Writing a Import Routine<Import_Routines>`
     2051    See :ref:`Writing a Import Routine<import_routines>`
    20512052    for an explanation on how to use import classes in general. The specifics
    20522053    for reading a structure factor histogram require that
     
    21032104
    21042105    Objects constructed that subclass this (in import/G2pwd_*.py etc.) will be used
    2105     in :meth:`GSASIIdataGUI.GSASII.OnImportPowder`.
    2106     See :ref:`Writing a Import Routine<Import_Routines>`
     2106    in :meth:`GSASIIdataGUI.GSASII.OnImportPowder` and in
     2107    :func:`GSASIIscriptable.import_generic`.
     2108    See :ref:`Writing a Import Routine<import_routines>`
    21072109    for an explanation on how to use this class.
    21082110    '''
     
    21462148class ImportSmallAngleData(ImportBaseclass):
    21472149    '''Defines a base class for the reading of files with small angle data.
    2148     See :ref:`Writing a Import Routine<Import_Routines>`
     2150    See :ref:`Writing a Import Routine<import_routines>`
    21492151    for an explanation on how to use this class.
    21502152    '''
     
    21802182class ImportReflectometryData(ImportBaseclass):
    21812183    '''Defines a base class for the reading of files with reflectometry data.
    2182     See :ref:`Writing a Import Routine<Import_Routines>`
     2184    See :ref:`Writing a Import Routine<import_routines>`
    21832185    for an explanation on how to use this class.
    21842186    '''
     
    22142216class ImportPDFData(ImportBaseclass):
    22152217    '''Defines a base class for the reading of files with PDF G(R) data.
    2216     See :ref:`Writing a Import Routine<Import_Routines>`
     2218    See :ref:`Writing a Import Routine<import_routines>`
    22172219    for an explanation on how to use this class.
    22182220    '''
     
    22482250        methods :meth:`ExtensionValidator`, :meth:`ContentsValidator` and
    22492251        :meth:`Reader`. This returns a list of reader objects for each read image.
     2252        Also used in :func:`GSASIIscriptable.import_generic`.
    22502253
    22512254      * Images are read alternatively in :func:`GSASIIIO.ReadImages`, which puts image info
     
    22532256
    22542257      * Images are reloaded with :func:`GSASIIIO.GetImageData`.
    2255 
    2256     .. _Image_import_routines:
    22572258
    22582259    When reading an image, the ``Reader()`` routine in the ImportImage class
     
    22812282
    22822283    Note that the above is initialized with :meth:`InitParameters`.
    2283     (Also see :ref:`Writing a Import Routine<Import_Routines>`
     2284    (Also see :ref:`Writing a Import Routine<import_routines>`
    22842285    for an explanation on how to use import classes in general.)
    22852286    '''
  • trunk/docs/source/imports.rst

    r3822 r3823  
    155155in a file.
    156156
     157.. _ContentsValidator: 
     158
    157159ContentsValidator()
    158160~~~~~~~~~~~~~~~~~~~~
    159 
    160 .. _ContentsValidator:
    161161
    162162Defining a ``ContentsValidator`` method is optional, but is usually a
     
    301301Image import routines are classes derived from
    302302:class:`GSASIIIO.ImportImage`.
    303 See :ref:`Writing a Import Routine<Import_Routines>` for general
    304 information on importers and
    305 :ref:`the ImportImage docstring<Image_import_routines>`
    306 for what a reader should define.
     303See :ref:`Writing a Import Routine<import_routines>` for general
     304information on importers and the :class:`GSASIIobj.ImportImage` for
     305information on what class variables a reader should set.
    307306Image importers must be found in files named `G2img*.py` that are in the Python path
    308307and the class must override the ``__init__`` method and add a
Note: See TracChangeset for help on using the changeset viewer.