source: sasview/guiframe/docs/sphinx/genmods.py @ 4986ce7

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since 4986ce7 was d955bf19, checked in by Gervaise Alina <gervyh@…>, 14 years ago

working on documentation

  • Property mode set to 100644
File size: 2.7 KB
Line 
1from __future__ import with_statement
2import os.path
3
4MODULE_TEMPLATE=""".. Autogenerated by genmods.py
5
6******************************************************************************
7%(name)s
8******************************************************************************
9
10:mod:`%(package)s.%(module)s`
11==============================================================================
12
13.. automodule:: %(package)s.%(module)s
14   :members:
15   :undoc-members:
16   :inherited-members:
17   :show-inheritance:
18
19"""
20
21INDEX_TEMPLATE=""".. Autogenerated by genmods.py
22
23.. _api-index:
24
25##############################################################################
26   %(package_name)s
27##############################################################################
28
29.. only:: html
30
31   :Release: |version|
32   :Date: |today|
33
34.. toctree::
35
36   %(rsts)s
37"""
38
39
40def genfiles(package, package_name, modules, dir='api'):
41
42    if not os.path.exists(dir):
43        os.makedirs(dir)
44
45    for module,name in modules:
46        with open(os.path.join(dir,module+'.rst'), 'w') as f:
47            f.write(MODULE_TEMPLATE%locals())
48
49    rsts = "\n   ".join(module+'.rst' for module,name in modules)
50    with open(os.path.join(dir,'index.rst'),'w') as f:
51        f.write(INDEX_TEMPLATE%locals())
52
53
54modules=[
55         ('aboutbox', 'aboutbox'),
56    ('config', 'config'),
57    ('data_loader', 'data_loader'),
58    ('dataFitting', 'dataFitting'),
59    ('dummyapp', 'dummyapp'),
60    ('gui_manager', 'gui_manager'),
61    ('load_thread', 'load_thread'),
62    ('statusbar', 'statusbar'),
63    ('utils', 'utils'),
64    ('version', 'version'),
65]
66package = 'sans.guiframe'
67package_name='Reference'
68
69if __name__ == "__main__":
70    genfiles(package, package_name, modules, dir='api')
71   
72    modules=[
73             ('AnnulusSlicer', 'AnnulusSlicer'),
74             ('Arc', 'Arc'),
75             ('AzimutSlicer', 'AzimutSlicer'),
76             ('BaseInteractor', 'BaseInteractor'),
77             ('binder', 'binder'),
78             ('boxMask', 'boxMask'),
79             ('boxSlicer', 'boxSlicer'),
80             ('boxSum', 'boxSum'),
81             ('detector_dialog', 'detector_dialog'),
82             ('Edge', 'Edge'),
83             ('masking', 'masking'),
84             ('Plotter1D', 'Plotter1D'),
85             ('Plotter2D', 'Plotter2D'),
86             ('plotting', 'plotting'), 
87             ('sectorMask', 'sectorMask'),
88             ('SectorSlicer', 'SectorSlicer'),
89             ('slicerpanel', 'slicerpanel'),
90             ('SlicerParameters', 'SlicerParameters'),
91             ]
92    package = 'sans.guiframe.local_perspectives.plotting'
93    package_name = 'Local Perspective: Plotting'
94    genfiles(package, package_name, modules, dir='api/local_perspectives/plotting')
95    print "Sphinx: generate .rst files complete..."
96   
Note: See TracBrowser for help on using the repository browser.