[19dcb933] | 1 | from __future__ import with_statement |
---|
| 2 | import os.path |
---|
| 3 | |
---|
| 4 | MODULE_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 | |
---|
| 21 | INDEX_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 | |
---|
| 43 | def 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 | |
---|
| 57 | modules=[ |
---|
| 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 | ] |
---|
| 68 | package='sasmodels' |
---|
| 69 | package_name='Reference' |
---|
| 70 | genfiles(package, package_name, modules) |
---|