Ich habe eine dreischichtige Klassenstruktur wie folgt:
%Vor% Meine index.rst
-Datei sieht wie folgt aus:
Sphinx erzeugt eine nette API-Dokumentation für mich. Es enthält die Klassen Super
und Sub
mit den entsprechenden Kommentaren. Es enthält Intermediate
nicht, da es keinen Kommentar enthält und ich das undoc-members
-Flag nicht angegeben habe. Das liegt daran, dass Intermediate
nicht in der Dokumentation angezeigt werden soll.
Mein Problem ist folgendes: Weil ich das show-inheritance
Flag zur Verfügung stelle, zeigt Sphinx die Basen für jede Klasse an; object
für Super
und Intermediate
für Sub
. Da Intermediate
undokumentiert ist, möchte ich nicht, dass es in der Liste der Basisklassen auftaucht. Stattdessen möchte ich, dass Sphinx die nächste dokumentierte Klasse im Vererbungsbaum Super
anzeigt. Mit anderen Worten: Ich möchte, dass Sphinx Super
, nicht Intermediate
als Basisklasse von Sub
anzeigt.
Weiß jemand, wie man das macht?
Tags und Links python python-sphinx python-2.7