|
Revision 128, 0.9 kB
(checked in by apdavison, 10 months ago)
|
Major modification to the way that ParameterSets are saved to file - they should now be a dict definition that can be evaled to give the ParameterSet content (i.e. the right hand side of a dict declaration), whereas before the file contents were execed. The main reason for this is to make sure that repeatedly saving and loading does not change the contents. Two positive side effects are (i) eval may be more secure than exec, although I have not really thought about this, (ii) the format is now rather close to JSON (while still being valid Python), which may be beneficial later on for working with ParameterSets remotely. The main negative side-effects are (i) writing parameter set files by hand is slightly more verbose, (ii) parameter set files can no longer be simply imported as Python modules. If these changes affect anyone negatively, they can be reverted and we can discuss together the best file format.
|
| Line | |
|---|
| 1 |
=========================== |
|---|
| 2 |
Notes on NeuroTools documentation |
|---|
| 3 |
=========================== |
|---|
| 4 |
|
|---|
| 5 |
The text files in this directory (including this one) are in reStructuredText_ format, which can easily be processed into HTML or LaTeX formats using Docutils_, e.g.:: |
|---|
| 6 |
|
|---|
| 7 |
$ rst2html.py --initial-header-level=2 parameters.txt > parameters.html |
|---|
| 8 |
|
|---|
| 9 |
They can also be pasted directly into the Trac wiki, which supports reStructuredText as an alternative markup. |
|---|
| 10 |
|
|---|
| 11 |
API documentation is generated using the ``wikidoc.py`` script, which can produce MediaWiki, Trac Wiki, or LaTeX formats (but not, currently, reStructuredText). |
|---|
| 12 |
|
|---|
| 13 |
Many of the files contain examples of interactive python sessions. The validity of this code can be tested by running, for example:: |
|---|
| 14 |
|
|---|
| 15 |
$ python testdocs.py parameters.txt |
|---|
| 16 |
|
|---|
| 17 |
.. _reStructuredText: http://docutils.sourceforge.net/rst.html |
|---|
| 18 |
.. _Docutils: http://docutils.sourceforge.net/ |
|---|
