Excluding particular base classes from autodoc inherited-members

[Jake Vanderplas]

Hi all,

I hope to use autodoc for a project I'm working on. Most of my classes inherit from some very low-level base classes, whose methods I don't want in the documentation.

Unfortunately, there are some other parent classes whose methods I *do* want documented, so simply excluding autodoc's :inherited-members: is not an option.

Is there a way to specify particular base classes to exclude when using autodoc's :inherited-members: option? If not, I'll probably end up forking autodoc to extend it this way... thanks!

   Jake

[Komiya Takeshi]

Hi Jake,

As far as I know, there are no option to do that.

Thanks,

2016年9月16日金曜日 0時41分01秒 UTC+9 Jake:

[Jake Vanderplas]

Thanks Komiya,

In case anyone comes across this thread, what I ended up doing was creating a custom Documenter for the objects in question which injects an :exclude-members: option that explicitly lists every member of the base class. A bit clunky, maybe, but it works.

Code is here: https://github.com/ellisonbg/altair/blob/e4eff3ce59947b203ee08768c917a4976fd16071/doc/sphinxext/altair_ext/altair_autodoc.py#L53

   Jake

--
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 sphinx-users+unsubscribe@googlegroups.com.
To post to this group, send email to sphinx...@googlegroups.com.
Visit this group at https://groups.google.com/group/sphinx-users.
For more options, visit https://groups.google.com/d/optout.