Re: [pygame] Using reStructuredText for document sources

[René Dudfield <renesd@xxxxxxxxx>]

On Sat, Mar 5, 2011 at 7:00 AM, Peter Shinners <pete@xxxxxxxxxxxx> wrote:

[snip...]
Doing a one time conversion from the current Pygame docs should be easy, it was always meant to be.  One current feature is that function signatures and summaries are translated into header files that are built into the extension source. One big missing feature is that reference docs do not pull docstrings from of the .py files, which was always desired.

Hey ya,

There's a tool to create .doc files from modules that were made for the last release.
    python create_doc_from_py.py pygame.sprite

There's also a tool to help find out what is not documented:
    python compare_docs.py pygame.sprite sprite.doc

They're hidden in the test/util/ directory... but I've documented them in the Hacking guide with the rest of the documentation on writing docs for pygame lives.
    http://pygame.org/wiki/Hacking


cya!