[Doc-SIG] autogenerating API docs using sphinx
Ondrej Certik
ondrej at certik.cz
Tue Apr 15 11:34:39 CEST 2008
On Tue, Apr 15, 2008 at 11:26 AM, Gael Varoquaux
<gael.varoquaux at normalesup.org> wrote:
>
> On Mon, Apr 14, 2008 at 09:16:34PM -0500, skip at pobox.com wrote:
>
> > Would it perhaps be better to create a Sphinx backend for an existing
> > source-to-documentation tool like doxygen? I have no idea how hard or
> > feasible that would be or if there are better candidate tools. Doxygen just
> > happens to be one I am grudingly familiar with because the C++ programmers
> > at work use it. If successful it would have the added benefit of exposing
> > Sphinx and restructured text outside the Python world.
>
> That would be great, but it wouldn't replace what I am doing. I have
> taylored in my autogeneration of docs a lot of smart guessing (special
> cases for my module?) to have a usable and readable doc generated. I hate
> the docs generated by tools like doxygen. They are just not meant for end
> users, but for programmers.
>
> Two purposes, two tools; fair enough.
Yep. I myself am looking for something that Gael is doing -- simple
API docs for endusers (and myself too!), that quickly shows me, what
kind of stuff I can do. For everything else, I can either use epydoc,
or just look into the sources directly (that's what I prefer).
Ondrej
More information about the Doc-SIG
mailing list