Re: [Doc-SIG] autogenerating API docs using sphinx

2008-04-14 Thread skip
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 wo

Re: [Doc-SIG] autogenerating API docs using sphinx

2008-04-14 Thread Ondrej Certik
On Tue, Apr 15, 2008 at 12:20 AM, Gael Varoquaux <[EMAIL PROTECTED]> wrote: > On Mon, Apr 14, 2008 at 11:51:32PM +0200, Ondrej Certik wrote: > > > 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 > > modul

Re: [Doc-SIG] autogenerating API docs using sphinx

2008-04-14 Thread Gael Varoquaux
On Mon, Apr 14, 2008 at 11:51:32PM +0200, Ondrej Certik wrote: > 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. I just did something similar this week end. I would like to get it

[Doc-SIG] autogenerating API docs using sphinx

2008-04-14 Thread Ondrej Certik
Hi, 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