Changeset 989 for trunk

Timestamp:

09/15/11 13:46:33 (8 months ago)

Author:

apdavison

Message:

more on converting docs to Sphinx

Location:

trunk/doc

Files:

• api_reference.txt (added)
• highlevelapi.txt (modified) (1 diff)
• index.txt (modified) (1 diff)
• roadmap.txt (added)

trunk/doc/highlevelapi.txt

@@ -21 +21 @@
 ==========================
 
-Before using any other functions or classes from PyNN, the user must call the ``setup()`` function::
+Before using any other functions or classes from PyNN, the user must call the :func:`setup()` function::
 
     >>> setup()
     
-``setup()`` takes various optional arguments: setting the simulation timestep (there is currently no support in the API for variable timestep methods although native simulator code can be used to select this option where the simulator supports it) and setting the minimum and maximum synaptic delays, e.g.::
+:func:`setup()` takes various optional arguments: setting the simulation timestep (there is currently no support in the API for variable timestep methods although native simulator code can be used to select this option where the simulator supports it) and setting the minimum and maximum synaptic delays, e.g.::
 
     >>> setup(timestep=0.1, min_delay=0.1, max_delay=10.0)
     
-In previous versions, ``setup()`` took a ``debug`` argument for configuring logging. To allow more flexibility, configuration of logging must now be done separately. There is a convenience function in the ``pyNN.utility`` module to simplify this::
+In previous versions, :func:`setup()` took a :attr:`debug` argument for configuring logging. To allow more flexibility, configuration of logging must now be done separately. There is a convenience function in the :mod:`pyNN.utility` module to simplify this::
 
     >>> from pyNN.utility import init_logging
     >>> init_logging("logfile", debug=True)
     
-or you can configure the Python ``logging`` module directly.
+or you can configure the Python :mod:`logging` module directly.
 
 

trunk/doc/index.txt

@@ -19 +19 @@
    simulatorspecificoptions
    developers_guide
+   roadmap
+   api_reference
 
 Indices and tables