Connect Sphinx autodoc-skip-member to my function

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 Truedef 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...

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)

If anyone comes searching for same question but for AutoAPI instead of autodoc, the below snippet successfully excludes all attributes and methods from the AutoAPI generated documentation that begin with _; this isn't a great idea in practice but I wanted to start with something drastic for ease of detection.

def autoapi_skip_member(app, what, name, obj, skip, options):    """Exclude all private attributes, methods, and dunder methods from Sphinx."""    import re    exclude = re.findall('\._.*', str(obj))    return skip or excludedef setup(app):    """Add autoapi-skip-member."""    app.connect('autoapi-skip-member', autoapi_skip_member)

One quirk/oddity to call out is that that the same functions applied to name instead of str(obj) in the autoapi_skip_member function doesn't seem to work, which I was (apparently) mistakenly under the impression were the same thing ('fully qualified name of the object' per the AutoAPI docs).

This includes when throwing in something like the below to detect methods that start with _:

or (hasattr(obj, '__name__') and str(obj.__name__).startswith('_'))