I fully support this effort. While we're at it, I may add my pyglet tutorial (http://www.steveasleep.com/pyglettutorial) to the proper docs to send PageRank to the right place. I don't get much opportunity to use pyglet anymore and I don't want it to rot on my site for too long. I wrote the tutorial in Markdown, but I can convert it to reStructuredText with pandoc and clean up by hand.
Also, forking things on Google Code is a pain in the butt, which makes contributing more difficult. What are people's feelings toward moving to e.g. BitBucket, where the UI is a bit friendlier? Google Code seems to be a "big project, monolithic contributor" kind of site, but pyglet seems more and more like a "small project, many contributors" kind of project. (I suspect this idea will no go over well but there it is.) I'm comfortable with hg but I literally feel like it would be easier to email Richard a zip file with my contributions rather than fork and have him pull. On Mar 29, 12:53 pm, Richard Thomas <[email protected]> wrote: > 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 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.
