source: sasview/plottools/docs/sphinx/genmods.py @ ac2ceb9b

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 ac2ceb9b was 82a54b8, checked in by Mathieu Doucet <doucetm@…>, 13 years ago

adding plottools Part 2

  • 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
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    ('BaseInteractor', 'BaseInteractor'),
56    ('binder', 'binder'),
57    ('canvas', 'canvas'),
58    ('config', 'config'),
59    ('fitDialog', 'fitDialog'),
60    ('fittings', 'fittings'),
61    ('LineModel', 'LineModel'),
62    ('PlotPanel', 'PlotPanel'),
63    ('plottable_interactor', 'plottable_interactor'),
64    ('plottables', 'plottables'),
65    ('PropertyDialog', 'PropertyDialog'),
66    ('toolbar', 'toolbar'),
67    ('transform', 'transform'),
68    ('unitConverter', 'unitConverter'),
69]
70package = 'danse.common.plottools'
71package_name = 'Reference'
72
73if __name__ == "__main__":
74    genfiles(package, package_name, modules, dir='api')
75    print "Sphinx: generate .rst files complete..."
Note: See TracBrowser for help on using the repository browser.