Tuesday, December 15, 2009

python documentation generation

a few tools out there for generating docs for/from python code. docutils has a lot of core support and no dependencies, but it seems to be more of a library since the front-end stuff seems a little bare-bones and many others use its ReST parser. sphinx is a very impressive doc generator, with commensurately impressive packages using it. but they say it's not really designed for auto-api docs, more for stand-alone rst files written alongside the code. epydoc, otoh, is an auto-api generator that analyzes .py source to build the docs. it can use it's own format, or it can read rst (i think the better choice). can make dependency graphs, etc. i think i'll try this first. happydoc is another auto-api tool. i don't think it's used as much as epydoc.

No comments: