Static HTML documentation from docstrings

Chris Rebert clp2 at rebertia.com
Tue Feb 7 13:33:32 CET 2012


On Tue, Feb 7, 2012 at 4:11 AM, Florian Weimer <fw at deneb.enyo.de> wrote:
> I'm slightly confused about docstrings and HTML documentation.  I used
> to think that the library reference was (in part) generated from the
> source code, but this does not seem to be the case.
>
> Is there any tool support for keeping documentation and code in sync?

Yes. Sphinx's "autodoc" extension allows the placement of API
documentation directly in docstrings and comments:
http://sphinx.pocoo.org/ext/autodoc.html

Cheers,
Chris



More information about the Python-list mailing list