source: sasview/DataLoader/docs/sphinx/genmods.py @ 6db541f

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 6db541f was 0997158f, checked in by Gervaise Alina <gervyh@…>, 14 years ago

working on documentation

  • Property mode set to 100644
File size: 2.1 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    ('data_info', 'data_info'),
56    ('loader', 'loader'),
57    ('manipulations', 'manipulations'),
58    ('qsmearing', 'qsmearing'),
59    ('smearing_2d', 'smearing_2d'),
60]
61package='DataLoader'
62package_name='Reference'
63#genfiles(package, package_name, modules)
64
65if __name__ == "__main__":
66    genfiles(package, package_name, modules, dir='api')
67   
68    modules=[
69    ('abs_reader', 'abs_reader'),
70    ('ascii_reader', 'ascii_reader'),
71    ('associations', 'associations'),
72    ('cansas_reader', 'cansas_reader'),
73    ('hfir1d_reader', 'hfir1d_reader'),
74    ('IgorReader', 'IgorReader'),
75    ('red2d_reader', 'red2d_reader'),
76    ('tiff_reader', 'tiff_reader'),
77    ]
78    package='DataLoader.readers'
79    package_name='Readers'
80    genfiles(package, package_name, modules, dir='api/readers')
81    print "Sphinx: generate .rst files complete..."
Note: See TracBrowser for help on using the repository browser.