So correct me if I'm wrong: *sphinx-autodoc* provides api documentation for classes, but that documentation can not list all methods callable from the class.
Is that intentional? To me it appears to make the whole exercise futile. The resulting docs are at best difficult to use, and at worst incomplete. Consider this a feature request! On Monday, January 19, 2015 at 1:51:01 PM UTC-5, Gary Pajer wrote: > > I also have this issue. "inherited-members" causes a link to the > superclass to be included in the docs. My problem (and the OP, if I > understand it correctly) is that I want the documentation (or at least > mention and a link) of the inherited methods' docs to be displayed in the > docs for the sub-class. I don't want to climb the inheritance tree and > examine each superclass in turn. (doxygen and/or javadocs have this > capablilty, I think.) > > > > On Tuesday, June 17, 2014 at 5:22:53 AM UTC-4, Martin Luessi wrote: >> >> Thanks, I tried what you suggested and unfortunately it doesn't help. >> Also, we have autodoc_default_flags = ['members', 'inherited-members']` >> set, so it is strange that inherited members are not shown. If I set >> "show-inheriatnce", autodoc show the correct base class. So it definitely >> knows what the base class is but for reason it doesn't document the members >> inherited from it. >> >> On Monday, June 16, 2014 8:40:58 PM UTC-4, Takayuki SHIMIZUKAWA wrote: >>> >>> Hi, >>> >>> I've commented to github PR you mentioned. >>> `:inherited-members:` option should be placed before some directive >>> contents. >>> >>> And a `autodoc_default_flags = ['members', 'inherited-members']` >>> conf.py parameter also works fine to me. >>> >>> Regards, >>> -- >>> Takayuki SHIMIZUKAWA >>> http://about.me/shimizukawa >>> >>> >>> 2014-06-16 23:56 GMT+09:00 Martin Luessi <[email protected]>: >>> > Hi, >>> > >>> > We have been using sphinx to build the documentation for our project >>> > (http://martinos.org/mnel) with great success. One problem we >>> currently have >>> > is that inherited members in classes are not documented even though >>> the >>> > "inherited-members" autodoc option is enabled. Does anyone know what >>> could >>> > be causing this? The issue for this problem is here: >>> > https://github.com/mne-tools/mne-python/pull/1364 >>> > >>> > Best, >>> > >>> > Martin >>> > >>> > -- >>> > You received this message because you are subscribed to the Google >>> Groups >>> > "sphinx-users" group. >>> > To unsubscribe from this group and stop receiving emails from it, send >>> an >>> > email to [email protected]. >>> > To post to this group, send email to [email protected]. >>> > Visit this group at http://groups.google.com/group/sphinx-users. >>> > For more options, visit https://groups.google.com/d/optout. >>> >> -- You received this message because you are subscribed to the Google Groups "sphinx-users" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To post to this group, send email to [email protected]. Visit this group at http://groups.google.com/group/sphinx-users. For more options, visit https://groups.google.com/d/optout.
