source: sasmodels/doc/genapi.py @ 87c722e

core_shell_microgelscostrafo411magnetic_modelrelease_v0.94release_v0.95ticket-1257-vesicle-productticket_1156ticket_1265_superballticket_822_more_unit_tests
Last change on this file since 87c722e was 19dcb933, checked in by Paul Kienzle <pkienzle@…>, 10 years ago

build docs for models

  • Property mode set to 100644
File size: 1.8 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   :titlesonly:
36   :numbered: 1
37   :maxdepth: 2
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
56
57modules=[
58    #('__init__', 'Top level namespace'),
59    ('bumps_model', 'Bumps interface'),
60    ('sasview_model', 'Sasview interface'),
61    ('weights', 'Distribution functions'),
62    ('gen', 'Model generator'),
63    ('convert', 'Model parameter converter'),
64    ('gpu', 'OpenCL model loader'),
65    ('dll', 'Ctypes model loader'),
66    #('transition', 'Model stepper for automatic model selection'),
67]
68package='sasmodels'
69package_name='Reference'
70genfiles(package, package_name, modules)
Note: See TracBrowser for help on using the repository browser.