Connect Sphinx autodoc-skip-member to my function
This answer expands upon the answer by bstpierre. It implements autodoc-skip-member
. Below is the relevant portion from my conf.py
:
autodoc_default_flags = ['members', 'private-members', 'special-members',
#'undoc-members',
'show-inheritance']
def autodoc_skip_member(app, what, name, obj, skip, options):
# Ref: https://stackoverflow.com/a/21449475/
exclusions = ('__weakref__', # special-members
'__doc__', '__module__', '__dict__', # undoc-members
)
exclude = name in exclusions
# return True if (skip or exclude) else None # Can interfere with subsequent skip functions.
return True if exclude else None
def setup(app):
app.connect('autodoc-skip-member', autodoc_skip_member)
Aha, last ditch effort on a little googling turned up this example, scroll down to the bottom. Apparently a setup() function in conf.py will get called with the app. I was able to define the following at the bottom of my conf.py:
def maybe_skip_member(app, what, name, obj, skip, options):
print app, what, name, obj, skip, options
return True
def setup(app):
app.connect('autodoc-skip-member', maybe_skip_member)
Which is obviously useless (it skips everything), but that's the minimal example I was looking for and couldn't find...