[Doc-SIG] autogenerating API docs using sphinx
gael.varoquaux at normalesup.org
Tue Apr 15 11:26:21 CEST 2008
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.
More information about the Doc-SIG