pythonpython-sphinxautodoc

Connect Sphinx autodoc-skip-member to my function


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.


Solution

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