source: sasview/calculatorview/docs/sphinx/genmods.py @ 6e01f06

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

edit calculator docs

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