===========================
Notes on NeuroTools documentation
===========================

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.::

    $ rst2html.py --initial-header-level=2 parameters.txt > parameters.html

They can also be pasted directly into the Trac wiki, which supports reStructuredText as an alternative markup.

API documentation is generated using the ``wikidoc.py`` script, which can produce MediaWiki, Trac Wiki, or LaTeX formats (but not, currently, reStructuredText).

Many of the files contain examples of interactive python sessions. The validity of this code can be tested by running, for example::

    $ python testdocs.py parameters.txt

.. _reStructuredText: http://docutils.sourceforge.net/rst.html
.. _Docutils: http://docutils.sourceforge.net/