source: sasview/prview/docs/sphinx/genmods.py @ 3e41f43

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 3e41f43 was 7116b6e0, checked in by Gervaise Alina <gervyh@…>, 14 years ago

working on documentation

  • Property mode set to 100644
File size: 1.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
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
54
55modules=[
56    ('explore_dialog', 'explore_dialog'),
57    ('inversion_panel', 'inversion_panel'),
58    ('inversion_state', 'inversion_state'), 
59    ('pr_thread', 'pr_thread'), 
60    ('pr_widgets', 'pr_widgets'), 
61    ('pr', 'pr'), 
62]
63package ='sans.perspectives.pr'
64package_name ='Reference'
65
66if __name__ == "__main__":
67    genfiles(package, package_name, modules, dir='api/perspectives/pr')
68
69    print "Sphinx: generate .rst files complete..."
70   
Note: See TracBrowser for help on using the repository browser.