The Voidspace Techie Blog

Gravatar have you liked at Fredrik Lundh's PythonDoc? It's quite convenient because it parses the python source and produces an xml infoset that you can turn into whatever you want.


Gravatar Well, pydoctor, predictably enough coming from me.

It documents everything at the moment, it shouldn't be hard to limit it to only "public" stuff (so long as this can be algorithmically determined of course). Let me know if you can't find the code to tweak


Gravatar Attributes or method with a leading underscore are private.

It would be nice to be able to recognise some of the 'magic' methods like '__getitem__' and comment that the object is indexable.

Plain text output is pretty fixed, but XML to text should be straightforward.

I'lll look at both PythonDoc and pydoctor. Thanks


Gravatar Protest is a documentation generation tool that uses unit tests to describe behaviour.

Or at least, I think it does. I only gave it a passing glance a while back (the web site hasn't been a priority...)


Name:

Email:

URL:

Comment:  ? 

 

Commenting by HaloScan