Pocco: Python port of Docco (literate-programming-style documentation)
fitzgen.github.com
fitzgen.github.com
Please fork it on GitHub and make it cooler!
I prefer a "literate testing" approach, where you mix documentation with doctests. It's easier to tell a story when you show the reader what your API does, instead of its internals. And you will never have to worry about keeping the examples up-to-date with your code if you make them doctests.
Python, Ruby, Scheme, Lua, and CoffeeScript should all be supported (but it doesn't play nice with /* */ style JS, just //).
All code comments that are on their own line should become documentation on the left, for example:
# This should become docs
def this_is_the(code):
...
Take a look at the raw file on github, and compare it to the generated file: http://github.com/fitzgen/pocco/blob/master/pocco