I want to clarify a bit: 1.) I did not suggest to patch the module.rst with version that auto- generates the submodules (thus generating whole package documentation at once) for a good reason:
module.rst changes are backwards incompatible, if the old users of autosummary would use it, it would definitely screw the day for them. But I suggested to patch the autosummary functions, which I still intend to patch some more... 2.) Now I have a question, if package documentation generation is wanted for Sphinx also (not just my crazy venture), I could implement it lightly using *new template*, such as "package.rst", it would be run for *only packages*. This way we could create the package documentation system without interfering with old way where each package or module is run using module.rst. If one would switch, lets say, autosummary_use_package_template = True then package.rst template would be used for packages and module.rst for modules. And inside package.rst we could iterate all submodules and start generating their documentation (this actually works on my computer already). (Currently module.rst is used for packages *and* modules, which is the reason it's confusing) What do you think? 3.) I personally don't like the module.rst template because it splits all functions/classes to own pages, I have own module.rst where they appear to modules own page, and I have a feeling that others would like this feature also... But here is the backwards incompatibility problem, we cannot patch the module.rst this heavily. Maybe create yet another new module_inline.rst which would be invoked instead of module.rst, if option would be changed. On Jan 12, 12:14 pm, Ciantic <[email protected]> wrote: > Hi! > > I've been working on that particular *package* autodocumentation a lot > now, and I have a few more changes to that particular part of code to > make it very nice... EpyDoc like (as optional). I will paste the > patches and probably a example documentation I have generated to this > topic and to the issue itself. > > I don't recommend patching the the (2) patch yet, I'm making minor > changes to that at the moment. > > On Jan 12, 12:04 pm, Georg Brandl <[email protected]> wrote: > > > > > -----BEGIN PGP SIGNED MESSAGE----- > > Hash: SHA1 > > > Am 11.01.2010 18:16, schrieb Ciantic: > > > > Hi! > > > > I decided to post also here, I have implemented a way to get > > > submodules working for autosummary extension. > > > > Also I implemented to autosummary to respect __all__ of package/ > > > module. This is changes behavior, but I think not that many people are > > > yet using autosummary, since there was bug where all Classes were > > > included in Exceptions section also, one would think that would have > > > been spotted a long time ago? > > > Well, that particular bug was only present in the trunk, not the released > > version, and it seems that intersecting the set of trunk users with the > > set of autosummary users leaves just you :) > > > I assume that numpy (where autosummary was conceived) uses its own adapted > > version. > > > > See following issue, diff file is attached to it: > > >http://bitbucket.org/birkenfeld/sphinx/issue/317/submodules-to-autosu... > > > > Essentially the submodule iteration allows to generate *whole* > > > documentation for *package* like EpyDoc does with a custom module.rst: > > > > {{ fullname }} > > > {{ underline }} > > > I'll look at your patch for the next release, if it works as intended it > > could be the smoothest way to automatic package doc generation which is > > often requested. > > > > Also I've been wondering, can't that {{ underline }} be done with > > > {{ fullname|underline }}, I'm coming from Django and that would be the > > > most natural way to do it. > > > You're right, that could be replaced by {{ '-' * (fullname | length) }}. > > > cheers, > > Georg > > -----BEGIN PGP SIGNATURE----- > > Version: GnuPG v2.0.14 (GNU/Linux) > > > iEYEARECAAYFAktMSRoACgkQN9GcIYhpnLDqhgCfXMVNgWcO3dR4LzHhmlCAnmfA > > gcAAnAryd+6NYI0CI7RRf2WyWbv5ptfO > > =+5Y7 > > -----END PGP SIGNATURE-----
-- You received this message because you are subscribed to the Google Groups "sphinx-dev" group. To post to this group, send email to [email protected]. 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.
