Hi, On 24/05/11 06:06 AM, René Dudfield wrote:
I need to find a permanent home for the reST docs. Sphinx is obsessive/compulsive about preserving source doc directory structure when generating HTML. If I move the reST docs back into the lib and src directories, then these directories will show up in the docs directory. If you have no problem keeping all source docs together in reST/source then I will add them to trunk and everyone can start editing. I will also replace makedoc.py with a Sphinx version, renaming the original.Hello Travis,On Tue, May 24, 2011 at 2:46 PM, Travis Briggs <audiodude@xxxxxxxxx <mailto:audiodude@xxxxxxxxx>> wrote:Hi, I just started using pygame, and I'm finding the HTML docs/tutorial articles EXTREMELY helpful. One thing bothers me, though, and that's the fact that there are consistent typographical and grammatical errors throughout. Not to mention dead links (specifically the link to "Solar Wolf" in the newbie guide). I saw the tweet about updated docs (http://pygame.org/docstest/), but I spot checked a few of the major mistakes I had seen and they weren't fixed.yes, just the toolkit used to generate the documentation has been changed on that link.Just wondering, is there a moratorium on editing these docs? Like are they kept, warts and all, for posterity's sake? Or would people be interested in some copy-editing of them? I promise not to "fix everything" and only add proper punctuation, spelling and grammar (and fix dead links). your help would be welcomed. Please see http://pygame.org/wiki/HackingIt might be good to pick one module to start with(say color in src/color.doc), then once you're done send the patch to the list. Or I'm on irc sometimes (illume). We'll need to coordinate what we're doing, so once you're done post your changes to the list (separate thread for each file) and we'll review them - then commit them.@Lennard: when should we start editing the rst files instead of the .doc ones? It seems all issues are resolved now?
To generate the HTML your need the following Python packages installed: Sphinx, docutils, jinja2, and pygmemts. For Python 2.x, installing Sphinx will also grab and install its dependencies.
For Python 3.x only the latest repository versions work. Be sure to install Sphinx last so it does not grab the wrong dependency versions:
svn checkout http://svn.berlios.de/svnroot/repos/docutils/trunk/docutils hg clone http://dev.pocoo.org/hg/pygments-main pygments easy_install Jinja2==dev hg clone http://bitbucket.org/birkenfeld/sphinx/ sphinxOne thing I want to see is a consistent standard for describing a function/method call signature. It can be based on the Python docs (http://docs.python.org/documenting/index.html). However Python call signatures are ambiguous regarding keyword arguments. This is something I hope to fix for Pygame.
I am currently working on PixelArray and pixelcopy, so leave those pages alone for now. Otherwise, happy writing.
Lenard Lindstrom