Connect Sphinx autodoc-skip-member to my function

user_67022 0
Viewed 7527

I want to use sphinx's autodoc-skip-member event to select a portion of the members on a certain python class for documentation.

But it isn't clear from the sphinx docs, and I can't find any examples that illustrate: where do I put the code to connect this? I see Sphinx.connect and I suspect it goes in my conf.py, but when I try variations on this code in conf.py I can't find the app object that I should connect():

def maybe_skip_member(app, what, name, obj, skip,
                                  options):
    print app, what, name, obj, skip, options
    return False

# This is not even close to correct:
#from sphinx.application import Sphinx
#Sphinx().connect('autodoc-skip-member', maybe_skip_member)

A pointer to a simple example would be ideal.

autodoc python-sphinx python
3 Answers

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 exclude


def 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('_'))
user_71738920
Related