generating/formatting docs for sphinx

git-svn-id: https://psychopy.googlecode.com/svn/trunk@437 1c617f74-e3c1-11dd-95e1-755cbddbdd66

Author: peircej

PsychoPy2_screenshot.png

@@ -43,6 +43,7 @@ clean:
 	-rm -rf build/*
 
 html:
+	cp -f ../CHANGELOG.txt source/changelog.rst
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html
 	@echo
 	@echo "Build finished. The HTML pages are in build/html."

docs/Makefile

@@ -4,14 +4,13 @@ API (Reference)
 Contents:
 
 .. toctree::
-   :maxdepth: 1
-   
+   :maxdepth: 1   
+   :glob:
+
+   core
    visual
-   sound
-   event
-   log
-   data
-   serial
+   *
+
 
 Indices and tables
 ~~~~~~~~~~~~~~~~~~~~~~

docs/source/api/api.rst

@@ -1,5 +1,5 @@
-:mod:`psychopy.data`
-===================================
+:mod:`psychopy.data` - functions for storing/saving/analysing data
+==============================================================================
 
 .. automodule:: psychopy.data
     :members:#nicer if we do it properly, btu this is easy for now

docs/source/api/data.rst

@@ -1,5 +1,5 @@
-:mod:`psychopy.event`
-===================================
+:mod:`psychopy.event` - for getting keypress and mouse clicks
+==============================================================================
 
 .. automodule:: psychopy.event
     :members:

docs/source/api/dotstim.rst

@@ -2,4 +2,4 @@
 ===================================
 
 .. automodule:: psychopy.log
-    :members:#nicer if we do it properly, btu this is easy for now
+    :members:

docs/source/api/event.rst

@@ -0,0 +1,69 @@
+:mod:`psychopy.monitors`
+===================================
+
+Most users won't need to use the code here. In general the Monitor Centre interface is sufficient
+and monitors setup that way can be passed as strings to :class:`~psychopy.visual.Window` s. If there
+is some aspect of the normal calibration that you wish to override. eg::
+
+   from psychopy import visual, monitors
+   mon = monitors.Monitor('SonyG55')#fetch the most recent calib for this monitor
+   mon.setDistance(114)#further away than normal?
+   win = visual.Window(size=[1024,768], monitor=mon)
+    
+You might also want to fetch the :class:`~psychopy.monitors.Photometer` class for conducting your own calibrations
+    
+:class:`Monitor`
+------------------------------------
+.. autoclass:: psychopy.monitors.Monitor
+    :members: 
+    :undoc-members: 
+    
+--------
+    
+:class:`Photometer`
+------------------------------------
+.. autoclass:: psychopy.monitors.Photometer
+    :members: 
+    :undoc-members: 
+    
+--------
+    
+:class:`GammaCalculator`
+------------------------------------
+.. autoclass:: psychopy.monitors.GammaCalculator
+    :members: 
+    :undoc-members: 
+    
+--------
+    
+:func:`getAllMonitors`
+------------------------------------
+.. autofunction:: psychopy.monitors.getAllMonitors
+
+:func:`findPR650`
+------------------------------------
+.. autofunction:: psychopy.monitors.findPR650 
+
+:func:`getLumSeriesPR650`
+------------------------------------
+.. autofunction:: psychopy.monitors.getLumSeriesPR650
+
+:func:`getRGBspectra`
+------------------------------------
+.. autofunction:: psychopy.monitors.getRGBspectra
+
+:func:`gammaFun`
+------------------------------------
+.. autofunction:: psychopy.monitors.gammaFun
+
+:func:`gammaInvFun`
+------------------------------------
+.. autofunction:: psychopy.monitors.gammaInvFun
+
+:func:`makeDKL2RGB`
+------------------------------------
+.. autofunction:: psychopy.monitors.makeDKL2RGB
+
+:func:`makeLMS2RGB`
+------------------------------------
+.. autofunction:: psychopy.monitors.makeLMS2RGB

docs/source/api/log.rst

@@ -2,4 +2,5 @@
 ===================================
 
 .. automodule:: psychopy.serial
-    :members:#nicer if we do it properly, btu this is easy for now
+    :members:
+