• 2006
  • September
  • 10
  • Need a better documentation-generation system (Pydoc and pydoc2 just don't cut it...)

Need a better documentation-generation system (Pydoc and pydoc2 just don't cut it...)
Written by on in Snaking.


Spent the full work-day today on OpenGL-ctypes. The glGet* variables are now getting automatically registered. Image types, it turns out, seem to already be registered. I've also started work on making the docstrings more reasonable, little things like including the extension's Overview section in the docstring (so you can tell what the extension is intended to do).

I've also been working on how to make the wrapper objects self-document. At the moment I'm just using a hacked-up version of pydoc, but really, since 90% of the things are either ctypes functions or wrapper.Wrapper objects it's getting in the way more than it's helping.

I'm considering just writing it myself so that I can have full control over the process. I'd also like to make it look reasonably good. Still, lot of work to go to when the hacked up pydoc "works".

Comments

  1. Moof

    Moof on 09/12/2006 6:32 p.m. #


    Well, Twsited currently uses pydoctor, which seems to be a pretty nice system for online use, though it doesn't really generate a nice page for printout. It uses syntax similar to epydoc, but it's a lot more hackable, and is actively developed. Poke mwh on freenode to talk to the author.<br />
    <br />
    Pydoctor:<br />
    http://codespeak.net/svn/user/mwh/pydoctor/trunk/<br />
    <br />
    Twisted API (generated by pydoctor):<br />
    http://twistedmatrix.com/documents/current/api/

  2. Mike Fletcher

    Mike Fletcher on 09/16/2006 12:21 p.m. #


    Thanks Moof, checked it out, output seems a bit sparse at the moment (or, I suppose, clean, since I don't mind it at all), I'll give it a try if the epydoc route fails...

Comments are closed.

Pingbacks

Pingbacks are closed.