I'm experimenting with moving the documentation for Pyglet from Epydoc to 
Sphinx. Epydoc is becoming increasingly difficult to support with newer 
versions of Python and docutils and its output is starting to look fairly 
dated too. This is still an experiment; I'm not making a unilateral change 
to how our documentation is structured. I've added a clone for this effort 
so that people can offer comments or suggestions.

http://code.google.com/r/chardster-sphinx-docs

Go to the docs directory and type `make html` to build the documentation. 
You'll need Sphinx (and its dependencies) installed for this to work. If 
you have problems building the docs please tell me. I've had none which is 
significantly better than I can say about Epydoc. :-)

*Current Status*


   - Programming guide is being built correctly, not all API links are 
   working but these are not hard to fix. I just finished sorting out the 
   links in the second chapter and the changes needed are only minor.
   - API docs are being automatically generated from the docstrings. This 
   is currently done as one document per module but I'm aware that per-class 
   pages of documentation might be desirable. I also want to do something a 
   bit nicer with parameter lists and instance variables.
   - I haven't looked at formatting/templating in any great detail at this 
   stage.

-- 
You received this message because you are subscribed to the Google Groups 
"pyglet-users" group.
To view this discussion on the web visit 
https://groups.google.com/d/msg/pyglet-users/-/deYGMNp-km8J.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to 
[email protected].
For more options, visit this group at 
http://groups.google.com/group/pyglet-users?hl=en.

Reply via email to