Re: [sphinx-dev] classes inside automodule
-BEGIN PGP SIGNED MESSAGE- Hash: SHA1 Am 14.01.2011 09:59, schrieb Chris Withers: > On 14/01/2011 03:58, TP wrote: >>> If I do, for example: >>> >>> >>> .. automodule:: testfixtures >>> >>> .. class:: Comparison >>> >>> ...then I end up with two sections for the Comparison class, one >>> auto-generated and one with my manual bits. >>> >>> I thought the manual one was supposed to override the automated one? >> >> I don't think so. > > This paragraph implies it should be possible: > > """ > It’s possible to override the signature for explicitly documented > callable objects (functions, methods, classes) with the regular syntax > that will override the signature gained from introspection: > > .. autoclass:: Noodle(type) > > .. automethod:: eat(persona) > This is useful if the signature from the method is hidden by a decorator. > > New in version 0.4. > """ No, since your class is not explicitly autodocumented, but implicitly (by the "members" option). Georg -BEGIN PGP SIGNATURE- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0xZlgACgkQN9GcIYhpnLC0qQCfT5ZbPApMkx4H8rJBzVJh6X/3 5doAnRo9IO/8oeAddl/rLCdXyCvfHM6G =mOff -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 sphinx-dev@googlegroups.com. To unsubscribe from this group, send email to sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] classes inside automodule
On 14/01/2011 03:58, TP wrote: If I do, for example: .. automodule:: testfixtures .. class:: Comparison ...then I end up with two sections for the Comparison class, one auto-generated and one with my manual bits. I thought the manual one was supposed to override the automated one? I don't think so. This paragraph implies it should be possible: """ It’s possible to override the signature for explicitly documented callable objects (functions, methods, classes) with the regular syntax that will override the signature gained from introspection: .. autoclass:: Noodle(type) .. automethod:: eat(persona) This is useful if the signature from the method is hidden by a decorator. New in version 0.4. """ cheers, Chris -- Simplistix - Content Management, Batch Processing & Python Consulting - http://www.simplistix.co.uk -- 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 sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
Re: [sphinx-dev] classes inside automodule
On Thu, Jan 13, 2011 at 2:33 PM, Chris Withers wrote: > Hi All, > > If I do, for example: > > > .. automodule:: testfixtures > > .. class:: Comparison > > ...then I end up with two sections for the Comparison class, one > auto-generated and one with my manual bits. > > I thought the manual one was supposed to override the automated one? I don't think so. Did you try the exclude-members option at http://sphinx.pocoo.org/ext/autodoc.html#directive-automodule ? > > cheers, > > Chris > > PS: This and the other message I just posted on with Sphinx 1.0.6 > > -- > Simplistix - Content Management, Batch Processing & Python Consulting > - http://www.simplistix.co.uk > > -- > 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 > sphinx-dev+unsubscr...@googlegroups.com. > For more options, visit this group at > http://groups.google.com/group/sphinx-dev?hl=en. > > -- 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 sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
[sphinx-dev] classes inside automodule
Hi All, If I do, for example: .. automodule:: testfixtures .. class:: Comparison ...then I end up with two sections for the Comparison class, one auto-generated and one with my manual bits. I thought the manual one was supposed to override the automated one? cheers, Chris PS: This and the other message I just posted on with Sphinx 1.0.6 -- Simplistix - Content Management, Batch Processing & Python Consulting - http://www.simplistix.co.uk -- 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 sphinx-dev+unsubscr...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sphinx-dev?hl=en.
