[Doc-SIG] autogenerating API docs using sphinx
g.brandl at gmx.net
Sun Apr 20 11:47:53 CEST 2008
Ondrej Certik schrieb:
> 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
> modules/index sections.
> 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. :)
What does it do differently from autodoc, and could autodoc be extended
to cover your usecase as well?
Thus spake the Lord: Thou shalt indent with four spaces. No more, no less.
Four shall be the number of spaces thou shalt indent, and the number of thy
indenting shall be four. Eight shalt thou not indent, nor either indent thou
two, excepting that thou then proceed to four. Tabs are right out.
More information about the Doc-SIG