Changeset 2802 for trunk/docs

Timestamp:

Apr 23, 2017 9:30:38 PM (6 years ago)

Author:

toby

Message:

updates for doc build

Location:

trunk/docs/source

Files:

• GSASIIscripts.rst (modified) (1 diff)
• conf.py (modified) (3 diffs)
• imports.rst (modified) (3 diffs)

trunk/docs/source/GSASIIscripts.rst

@@ -14 +14 @@
     :members: 
 
+.. automodule:: makeBat
+    :members: 
+
 .. automodule:: unit_tests
     :members: 

trunk/docs/source/conf.py

@@ -36 +36 @@
         class colourselect(MagicMock): pass
         class resizewidget(MagicMock): pass
-
-sys.modules.update({'wx':wx()})
-sys.modules.update({'wx.aui':wx.aui()})
-sys.modules.update({'wx.html':wx.html()})
-sys.modules.update({'wx.grid':wx.grid()})
-sys.modules.update({'wx.lib':wx.lib()})
-sys.modules.update({'wx.wizard':wx.grid()})
-sys.modules.update({'wx.glcanvas':wx.lib()})
-sys.modules.update({'wx.lib.scrolledpanel':wx.lib.scrolledpanel()})
-sys.modules.update({'wx.lib.gridmovers':wx.lib.gridmovers()})
-sys.modules.update({'wx.lib.colourselect':wx.lib.gridmovers()})
-sys.modules.update({'wx.lib.resizewidget':wx.lib.resizewidget()})
+        class mixins(MagicMock):
+            class listctrl(MagicMock):
+                ListCtrlAutoWidthMixin = object
+                TextEditMixin = object
+
+sys.modules.update({'wx':wx(),
+    'wx.aui':wx.aui(),
+    'wx.html':wx.html(),
+        'wx.grid':wx.grid(),
+        'wx.lib':wx.lib(),
+        'wx.wizard':wx.grid(),
+        'wx.glcanvas':wx.lib(),
+        'wx.lib.scrolledpanel':wx.lib.scrolledpanel(),
+        'wx.lib.gridmovers':wx.lib.gridmovers(),
+        'wx.lib.colourselect':wx.lib.gridmovers(),
+        'wx.lib.resizewidget':wx.lib.resizewidget(),
+        'wx.lib.mixins':wx.lib.mixins(),
+        'wx.lib.mixins.listctrl':wx.lib.mixins.listctrl()})
+wx.aui.AUI_NB_TOP = 0
+wx.aui.AUI_NB_SCROLL_BUTTONS = 0
 
 class numpy(MagicMock):
@@ -68 +76 @@
 sys.modules.update({'scipy.special':scipy.optimize()})
 sys.modules.update({'scipy.misc':scipy.optimize()})
+sys.modules.update({'scipy.signal':scipy.optimize()})
+sys.modules.update({'scipy.cluster':scipy.optimize()})
+sys.modules.update({'scipy.cluster.vq':scipy.optimize()})
 
 class OpenGL(MagicMock):
@@ -84 +95 @@
 MOCK_MODULES = [
                 'pypowder', 'pyspg', 'pytexture', 'polymask', 'fellipse',
-                'matplotlib', 'matplotlib.backends', 'matplotlib.backends.backend_wx', 
-                'matplotlib.backends.backend_wxagg','pylab',
+                'matplotlib', 'matplotlib.backends', 'matplotlib.backends.backend_wx',
+                'matplotlib.colors',
+                'matplotlib.backends.backend_wxagg','pylab','matplotlib.collections',
                 'mpl_toolkits', 'mpl_toolkits.mplot3d', 'mpl_toolkits.mplot3d.axes3d',
+                'winreg','unpack_cbf','h5py'
                 ]
 sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)

trunk/docs/source/imports.rst

@@ -223 +223 @@
     :synopsis: Reads phase information from a CIF
 
+.. automodule:: G2phase_INS
+    :members: 
+
+
+
 Powder Data Import Routines
 ---------------------------------------------
@@ -248 +253 @@
     :members: 
     :synopsis: Reads powder data from a CIF
+
+.. automodule:: G2pwd_BrukerRAW
+    :members: 
+    :synopsis: Reads powder data from a Brucker .raw file
+
+.. automodule:: G2pwd_FP
+    :members: 
+
+.. automodule:: G2pwd_Panalytical
+    :members: 
+
+.. automodule:: G2pwd_csv
+    :members: 
+
+.. automodule:: G2pwd_rigaku
+    :members: 
+
+
 
 Single Crystal Data Import Routines
@@ -315 +338 @@
 .. automodule:: G2img_CheMin
     :members: 
+
+.. automodule:: G2img_CBF
+    :members: 
+
+.. automodule:: G2img_HDF5
+    :members: 
+
+PDF Import Routines
+-----------------------------------------------------
+PDF import routines are classes derived from
+:class:`GSASIIIO.ImportPDFData`. 
+See :ref:`Writing a Import Routine<Import_Routines>` for general information on importers. 
+
+The distributed routines are:
+
+.. automodule:: G2pdf_gr
+    :members: 
+
+Reflectometry Import Routines
+-----------------------------------------------------
+Reflectometry import routines are classes derived from
+:class:`GSASIIIO.ImportReflectometryData`. 
+See :ref:`Writing a Import Routine<Import_Routines>` for general information on importers. 
+
+The distributed routines are:
+
+.. automodule:: G2rfd_xye
+    :members: 
+
+