Verbinde Sphinx autodoc-skip-member mit meiner Funktion

Ich möchte das Autodoc-Skip-Member- Ereignis von sphinx verwenden , um einen Teil der Mitglieder auf einer bestimmten Python-Klasse für die Dokumentation auszuwählen.

Aber es ist nicht klar aus den Sphinx-Docs, und ich kann keine Beispiele finden, die illustrieren: Wo stelle ich den Code ein, um das zu verbinden? Ich sehe Sphinx.connect und ich vermute, es geht in meine conf.py, aber wenn ich versuche Variationen auf diesem Code in conf.py Ich kann nicht finden, die App-Objekt, das ich verbinden sollte ():

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) 

Ein Zeiger auf ein einfaches Beispiel wäre ideal.

2 Solutions collect form web for “Verbinde Sphinx autodoc-skip-member mit meiner Funktion”

Aha, letzter Graben Anstrengung auf ein wenig googeln drehte dieses Beispiel , scrollen Sie nach unten auf den Boden. Anscheinend wird eine setup () – Funktion in conf.py mit der App aufgerufen. Ich konnte folgendes am unteren Rand meiner conf.py definieren:

 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) 

Das ist offensichtlich nutzlos (es überspringt alles), aber das ist das minimale Beispiel, das ich gesucht habe und nicht finden konnte …

Diese Antwort erweitert die Antwort von bstpierre . Unten ist der relevante Teil von meinem conf.py :

 autodoc_default_flags = ['members', 'private-members', 'special-members', #'undoc-members', 'show-inheritance'] def autodoc_skip_member(app, what, name, obj, skip, options): exclusions = ('__weakref__', # special-members '__doc__', '__module__', '__dict__', # undoc-members ) exclude = name in exclusions return skip or exclude def setup(app): app.connect('autodoc-skip-member', autodoc_skip_member) 
  • Sphinx-Dokumentenmodul-Eigenschaften
  • Python-Sphinx-Variablen und Klassen-Eigenschaften im Automodul
  • Markierung von Klassen und / oder Methoden, wie in Sphinx veraltet
  • Immer sphinx, um korrekte Signatur zu erkennen
  • Django URLs in Sphinx Dokumentation einbeziehen?
  • Sphinx autodoc-skip-member-Handler: kann bei der Verwendung von napoleon nicht __init __ () anzeigen
  • Wie füge ich ein "vorheriges Kapitel" und "nächstes Kapitel" in der von Sphinx generierten Dokumentation hinzu?
  • Verhinderung der Unterabschnitt-Verschachtelung in Python Sphinx bei Verwendung von toctree
  • Gibt es echte Alternativen zu reStructuredText für Python-Dokumentation?
  • Wie hochgeladen von html-Dokumentation von sphinx zu github generiert?
  • Sphinx automodule: wie man die Klassen im selben Modul referenziert?
  • Python ist die beste Programmiersprache der Welt.