Changeset 1123 for trunk/exports/G2export_examples.py

Timestamp:

Oct 25, 2013 2:24:22 PM (9 years ago)

Author:

toby

Message:

add import and export routines to sphinx

File:

• trunk/exports/G2export_examples.py (modified) (2 diffs)

trunk/exports/G2export_examples.py

@@ -8 +8 @@
 # $Id$
 ########### SVN repository information ###################
-'''Code to demonstrate how GSAS-II data export routines are created
+'''
+*Module G2export_examples: Examples*
+-------------------------------------------
+
+Code to demonstrate how GSAS-II data export routines are created. The
+classes defined here, :class:`ExportPhaseText`, 
+:class:`ExportSingleText`, :class:`ExportPowderReflText`, 
+and :class:`ExportPowderText` each demonstrate a different type
+of export. Also see :class:`G2export_map.ExportMapASCII` for an
+example of a map export.
+
 '''
 import os.path
@@ -148 +158 @@
         self.CloseFile()
         print(str(hist)+' written to file '+str(self.filename))                        
-
 class ExportPowderReflText(G2IO.ExportBaseclass):
     '''Used to create a text file of reflections from a powder data set