Fri, 24 Oct 2008 12:02:12 -0700, percious wrote: > The source code was attached and is linked in the first post of this > thread.
Ah OK, sorry -- I'm reading this group via Gmane and it doesn't show your first post in this thread for some reason, so I thought this was a continuation of some private discussion. > Changes are as follows: > > * NumpyExt was made into a package > * autosummary_genarate.py was turned into a console script with the name > sphinx-autogen > * module .rst generation was moved over to a jinja template, and > functions, classes, and exceptions within that module are now auto- > documented. Looks good to me! Do you want this in Sphinx's Google code repository? > I had a hard time figuring out how to use autosummary, and since I want > to do a presentation at pycon about it, I'd like to have it be really > easy to use. I'd also rather see it being included in sphinx, as > apposed to a separate package. I'd also like to see sphinx-quickstart > have an automatic option for creating an index with all of the modules > in a package linked. I agree with you here; I'd like to see something like autosummary in Sphinx proper at some point -- at least for Numpy including several long docstrings on one page made the documentation overwhelming. I don't think compressing consecutive function documentation listings to a table of brief descriptions severely undermines Sphinx's focus on narrative documentation. The present implementation could still be cleaned up a bit, though (hint hint! :) - The generated PDF documentation looks ugly in some cases as the functions are inserted immediately below the table. A workaround could be more clever placement of the toctree element. Or some other bright ideas how to make the output better. - Sometimes one wants the members of classes documented on the automatically generated page, sometimes not. autosummary_generate.py should probably be made smart enough not to generate the page when the documentation is manually written somewhere else. - The generated HTML documentation for Numpy weighs quite many megabytes; the same boilerplate appears in each individual HTML page. - Documentation is indeed quite sparse. And probably many other issues. -- Pauli Virtanen --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To post to this group, send email to sphinx-dev@googlegroups.com To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en -~----------~----~----~----~------~----~------~--~---
