Sphinx for API documentation

Paul Hildebrandt paul_hildebrandt at yahoo.com
Fri Mar 6 02:23:21 CET 2009


On Mar 5, 1:22 pm, Benjamin Peterson <benja... at python.org> wrote:
> 2009/3/5 andrew cooke <and... at acooke.org>:
>
> > Benjamin Peterson wrote:
> >> Paul Hildebrandt <paul_hildebrandt <at> yahoo.com> writes:
> >>> I really like the look of Sphinx BUT I want autogenerated
> >>> documentation like Epydoc/doxygen.  Does anyone know of a frontend for
> >>> Sphix that will make it work like Epydoc?
>
> >> There's a Sphinx extension called autodoc which should help you.
>
> > i am only vaguely remembering here, but iirc that helps you generate
> > something rather like python's own documentation for classes.  it's
> > nothing like as complete as epydoc.  i was in the same situation and ended
> > up using both.  you can link back + forth without too much bother.  it's a
> > bit of an aesthetic shock (to put it politely) going from sphinx to
> > epydoc, but it's a lot more useful for someone who wants to see source
> > etc.
>
> Basically it lets you use reST in docstrings. Seehttp://sphinx.pocoo.org/ext/autodoc.html
>
> --
> Regards,
> Benjamin

Thanks, I've been playing with that but I believe it assumes a reST
structure you build, then use autodoc to bring in your code's
docstrings.  I would rather not hand generate the main reST
structure.  I am hoping to use Sphinx like Epydoc and just run it on a
code base and have it generate the API documentation.

Paul



More information about the Python-list mailing list