[Author Prev][Author Next][Thread Prev][Thread Next][Author Index][Thread Index]

Re: Moved to reStructuredText (Re: [pygame] Where does pygame dev take place)



Hi,

Please start editing the docs/reST/ref/*.rst files.

Lenard

On 25/05/11 01:52 AM, René Dudfield wrote:
cool

Just checking... do we edit the reST/source/ref/*.rst files from now on?



On Tue, May 24, 2011 at 7:34 PM, Lenard Lindstrom <len-l@xxxxxxxxx <mailto:len-l@xxxxxxxxx>> wrote:

    The reST source is now committed to svn. The Pygame reference rst
    files are in reST/source/ref . Run makeref.py to generate the HTML
    using Sphinx (The original is now makeref_from_docs.py.) If all
    goes well the original .doc files can be removed at a later time.

    Maybe we should let the Sphinx people know so they can include
    Pygame in the "Projects that use Sphinx" list.

    Lenard

    On 24/05/11 09:55 AM, Lenard Lindstrom wrote:

        Hi,

        On 24/05/11 06:06 AM, René Dudfield wrote:


            @Lennard: when should we start editing the rst files
            instead of the .doc ones?  It seems all issues are
            resolved now?

        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.