source: sasview/sansmodels/docs/sphinx/genmods.py @ 01de557

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 01de557 was c0d873f, checked in by Gervaise Alina <gervyh@…>, 13 years ago

edit docs for models

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