source: sasview/sanscalculator/docs/sphinx/genmods.py @ 6df04e43

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 6df04e43 was a4f04f2, checked in by Gervaise Alina <gervyh@…>, 13 years ago

edit doc

  • Property mode set to 100644
File size: 1.9 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   :special-members:
19   :private-members:
20"""
21
22INDEX_TEMPLATE=""".. Autogenerated by genmods.py
23
24.. _api-index:
25
26##############################################################################
27   %(package_name)s
28##############################################################################
29
30.. only:: html
31
32   :Release: |version|
33   :Date: |today|
34
35.. toctree::
36
37   %(rsts)s
38"""
39
40
41def genfiles(package, package_name, modules, dir='api'):
42
43    if not os.path.exists(dir):
44        os.makedirs(dir)
45
46    for module,name in modules:
47        with open(os.path.join(dir,module+'.rst'), 'w') as f:
48            f.write(MODULE_TEMPLATE%locals())
49
50    rsts = "\n   ".join(module+'.rst' for module,name in modules)
51    with open(os.path.join(dir,'index.rst'),'w') as f:
52        f.write(INDEX_TEMPLATE%locals())
53
54modules = []
55path = os.path.dirname(os.path.join('..', '..', 'sanscalculator'))
56path = os.path.join(path, 'src', 'sans', 'calculator')
57list = os.listdir(path)
58
59for item in list:
60    toks = os.path.splitext(os.path.basename(item))
61    if toks[1]=='.py' and toks[0] not in ["__init__"]:
62        exec "module = ('%s', '%s')"%(toks[0], toks[0])
63        modules.append(module)
64       
65package='sans.calculator'
66package_name='Reference'
67genfiles(package, package_name, modules)
68
69if __name__ == "__main__":
70    genfiles(package, package_name, modules, dir='api')
71    print "Sphinx: generate .rst files complete..."
Note: See TracBrowser for help on using the repository browser.