Fix documentation

[esdalmaijer]

website

1. Save documentation for PyGaze 0.4 and make it downloadable on website.
2. Update all online documentation to PyGaze 0.5 (and make it downloadable on website)
3. Make Tutorial,

source

1. Fix documentation for _eyetracker and _screen: remove docstring, and replace by see _baseclass.BaseClass
2. Fix docstrings of all pygaze.[module] and pygaze.[module].init to have it say something relevant (e.g. from BaseClass), instead of the Mouse reference as it is now (artefact from copy-pasting source).

timecourse

Most likely after New Year's.

[smathot]

I've been working on a way to easily generate documentation based on docstrings, mostly for the OpenSesame documentation. The module is called yamldoc:

• https://github.com/smathot/python-yamldoc

This might be something to use for PyGaze as well? You can see an example of this in the heisenberg branch of OpenSesame:

• https://github.com/smathot/OpenSesame/blob/heisenberg/openexp/_canvas/canvas.py

The yamldoc readme.md itself is also generated fully from docstrings.

[esdalmaijer]

Looks very neat! Will try to look at a way to integrate this in PyGaze (possibly via a bit of hacking of your code, though).

[smathot]

Basically, the only thing that would need to happen is re-formatting the docstrings in the various base* classes, according to the yamldoc syntax. No code changes would be required, and there wouldn't be any dependency on yamldoc, except an optional dependency if we want to use the yamldoc.docinherit metaclass for docstring inheritance.

Let me know what you want to do here. I could reformat the basetracker docstrings while working on the EyeLink integration.

[esdalmaijer]

It's on my PyGaze to-do list, so please do go ahead with reformatting anything. Trouble is that there's a bunch of other to-do lists that currently have priority over the PyGaze one, so my progress is very slow.