Changeset 4f82183 in sasview for sansguiframe/docs/sphinx

Timestamp:

Aug 9, 2011 8:43:46 AM (13 years ago)

Author:

Gervaise Alina <gervyh@…>

Branches:

master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

d075f58

Parents:

05d444f

Message:

edit configuration file for sphinx
edit setup.py to properly add data_package
remove unused import

Location:

sansguiframe/docs/sphinx

Files:

• conf.py (modified) (1 diff)
• genmods.py (modified) (3 diffs)
• index.rst (modified) (1 diff)

sansguiframe/docs/sphinx/conf.py

@@ -17 +17 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.append(os.path.abspath(os.path.dirname('../../guiframe')))
-path = '../../guiframe/local_perspectives/plotting'
-sys.path.append(os.path.abspath(os.path.dirname(path)))
+sys.path.append(os.path.abspath(os.path.join('..', '..', 'src')))
 sys.path.append(os.path.abspath('_extensions'))
 # -- General configuration -----------------------------------------------------

sansguiframe/docs/sphinx/genmods.py

@@ +1 @@
+"""
+This module generates .rst file for each python file under sans.guiframe.
+Please run this file to autogenerate .rst files and build sphinx doc.
+
+"""
+
+
+
+
 from __future__ import with_statement
 import os.path
@@ -39 +48 @@
 
 def genfiles(package, package_name, modules, dir='api'):
+    """
+    Generates .rst file for each python module under sans.guiframe
+    """
 
     if not os.path.exists(dir):
@@ -52 +64 @@
 
 
-modules=[
-         ('aboutbox', 'aboutbox'),
-    ('config', 'config'),
-    ('data_loader', 'data_loader'),
-    ('dataFitting', 'dataFitting'),
-    ('dummyapp', 'dummyapp'),
-    ('gui_manager', 'gui_manager'),
-    ('load_thread', 'load_thread'),
-    ('statusbar', 'statusbar'),
-    ('utils', 'utils'),
-    ('version', 'version'),
-]
-package = 'sans.guiframe'
-package_name='Reference'
+def create_module_tuple(path):
+    """
+    Create tuples of module  and module name
+    :param path: path of the a package directory
+    """
+    modules = []
+    list = os.listdir(path)
+    for item in list:
+        toks = os.path.splitext(os.path.basename(item))
+        if toks[1] == '.py' and toks[0] not in ["__init__"]:
+            exec "module = ('%s', '%s')"%(toks[0], toks[0])
+            modules.append(module)
+    return modules
 
 if __name__ == "__main__":
+   
+    path = os.path.join('..', '..', 'src', 'sans', 'guiframe')
+    modules = create_module_tuple(path)
+    package = 'sans.guiframe'
+    package_name = 'Reference'
     genfiles(package, package_name, modules, dir='api')
-    
-    modules=[
-             ('AnnulusSlicer', 'AnnulusSlicer'),
-             ('Arc', 'Arc'),
-             ('AzimutSlicer', 'AzimutSlicer'),
-             ('BaseInteractor', 'BaseInteractor'),
-             ('binder', 'binder'),
-             ('boxMask', 'boxMask'),
-             ('boxSlicer', 'boxSlicer'),
-             ('boxSum', 'boxSum'),
-             ('detector_dialog', 'detector_dialog'),
-             ('Edge', 'Edge'),
-             ('masking', 'masking'),
-             ('Plotter1D', 'Plotter1D'),
-             ('Plotter2D', 'Plotter2D'),
-             ('plotting', 'plotting'), 
-             ('sectorMask', 'sectorMask'),
-             ('SectorSlicer', 'SectorSlicer'),
-             ('slicerpanel', 'slicerpanel'),
-             ('SlicerParameters', 'SlicerParameters'),
-             ]
-    package = 'sans.guiframe.local_perspectives.plotting'
-    package_name = 'Local Perspective: Plotting'
-    genfiles(package, package_name, modules, dir='api/local_perspectives/plotting')
+    # build local plugin
+    for f in os.listdir(path):
+        if os.path.isdir(os.path.join(path, f)) and not f.startswith('.') \
+            and f not in ['images', 'media']:
+            if f  == "local_perspectives":
+                temp = os.path.join(path, f)
+                if os.path.isdir(temp):
+                    for tf in os.listdir(temp):
+                        if os.path.isdir(os.path.join(path, f, tf)) \
+                            and not tf.startswith('.') :
+                            package = "sans.guiframe"
+                            package += ".local_perspectives.%s" % str(tf)
+                            p = os.path.join(path, f, tf)
+                            package_name = 'Local Perspective: %s' % str(tf)
+                            modules = create_module_tuple(p)
+                            dir = os.path.join("api", "local_perspectives", tf)
+                            genfiles(package, package_name, modules, dir=dir)
+          
     print "Sphinx: generate .rst files complete..."
     

sansguiframe/docs/sphinx/index.rst

@@ -14 +14 @@
    api/index.rst
    api/local_perspectives/plotting/index.rst
+   api/local_perspectives/data_loader/index.rst
 
 Indices and tables