Ich versuche, den Google-Code-Stil zu verwenden, um eine Funktion zu dokumentieren, die ich dann mit sphinx mit der Napoleon-Erweiterung verwende, um Dokumentation für zu erstellen. Die Funktion ist insofern ungewöhnlich, als sie zwei Argumente zurückgibt. Ich glaube nicht, dass Napoleon damit klar kommt. Wenn ja, könnte mir jemand sagen, wie sie damit umgehen?
%Vor%Vielleicht bekomme ich eine Nachricht, dass es nicht großartig ist, mehrere Argumente zu codieren, aber können Sie das tun? Das erzeugte HTML behandelt diese beiden Zeilen als Teil einer Beschreibung für ein Argument. Wenn ich einen newline zwischen den Servern und der msg-Zeile anlege, hilft es, aber es dokumentiert immer noch einen arg.
Python gibt nur ein einzelnes Objekt zurück. Wenn Sie
anrufen %Vor%Dann erweitern Sie explizit das Tupel expression_list, das generiert wird, wenn die Funktion mit diesem Code zurückkehrt
%Vor%Ihr Docstring sollte so etwas lesen (mit dem Napoleon Google Style)
%Vor%Oder mit dem Napoleon NumPy-Stil:
%Vor%Sehen Sie sich die Python-Dokumente für an zurück und vielleicht ausdruck_liste
Google style unterstützt keine Mehrfach-Rückgabewerte. Als Workaround können Sie Folgendes verwenden:
%Vor%Dies führt zu einer schönen Ausgabe auch bei mehrzeiliger Beschreibung für jedes zurückgegebene Element.
Tags und Links python python-sphinx documentation-generation