[Doc-SIG] autogenerating API docs using sphinx
ondrej at certik.cz
Mon Apr 14 23:51:32 CEST 2008
I wrote a short script for autogenerating API from sources, the output
are .rst files that sphinx can parse and generate the docs in the
Unfortunately, if the docstrings are not written in rst, it's not
going to work properly. Also it uses python inspection (it's easy to
implement), instead of parsing the source files directly.
I am putting it here in case you find it useful. I wrote it for sympy
originally, but we are not using it yet, because the output contains
too much noise.
Please let me know if you improve it/fix it. :)
-------------- next part --------------
A non-text attachment was scrubbed...
Size: 4843 bytes
Desc: not available
Url : http://mail.python.org/pipermail/doc-sig/attachments/20080414/fcfef36f/attachment.py
More information about the Doc-SIG