-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 Am 17.10.2010 20:36, schrieb Vinay Sajip: > Is there a way of documenting inherited members selectively? Say I > have a class which inherits from another class as an implementation > detail. I want to document only certain inherited members. Hence: > > class Base(object): > def member_A(self): > pass > > def member_B(self): > pass > > def member_C_low_level_detail(self): > pass > > class Derived(Base): > def member_D(self): > pass > > Now, I'd like to do > > .. autoclass:: Derived > :members: member_A, member_B, member_D > :inherited-members: > > and have it only pick up those members named in :members: - but that > doesn't seem to be happening, and I get all inherited members. Is it > meant to work like this? In practice there are a lot more members in > the base class, and I only want to expose some of them in the docs.
Hi Vinay, if you list members explicitly, there's no need to give :inherited-members: at all. I've just updated the documentation to clarify this, since it was not documented that way. cheers, Georg -----BEGIN PGP SIGNATURE----- Version: GnuPG v2.0.16 (GNU/Linux) iEYEARECAAYFAk0o6i4ACgkQN9GcIYhpnLBkcQCfc2JzDyXgabJ9chtAnk7gKlQU oXkAn0WtmjubSIU/vhfsJTY73yFEBE/d =N3Ot -----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.
