Als «autodoc» getaggte Fragen

6
Sphinx Autodoc ist nicht automatisch genug
Ich versuche, mit Sphinx ein Projekt mit mehr als 5.000 Zeilen in Python zu dokumentieren. Es hat ungefähr 7 Basismodule. Soweit ich weiß, muss ich für die Verwendung von Autodoc für jede Datei in meinem Projekt folgenden Code schreiben: .. automodule:: mods.set.tests :members: :show-inheritance: Das ist viel zu langweilig, weil …
5
Wie dokumentiere ich mit Sphinxs Autodoc die __init __ (self) -Methode einer Klasse?
Sphinx generiert standardmäßig keine Dokumente für __init __ (self). Ich habe folgendes versucht: .. automodule:: mymodule :members: und ..autoclass:: MyClass :members: Wenn Sie in conf.py Folgendes festlegen, wird nur die __init __ (selbst) docstring an die Klasse docstring angehängt ( die Sphinx-Autodoc-Dokumentation scheint zuzustimmen, dass dies das erwartete Verhalten ist, …
7
Wie kann ein ** kwargs-Parameter richtig dokumentiert werden?
Ich verwende Sphinx und das Autodoc-Plugin, um API-Dokumentation für meine Python-Module zu generieren. Ich kann zwar sehen, wie bestimmte Parameter gut dokumentiert werden, aber ich kann kein Beispiel dafür finden, wie ein **kwargsParameter dokumentiert wird. Hat jemand ein gutes Beispiel für eine klare Möglichkeit, diese zu dokumentieren?
1
Sphinx-Fehler: Unbekannter Anweisungstyp "Automodul" oder "Autoklasse"
Ich muss mein Python-Projekt mit Sphinx dokumentieren. Aber ich kann nicht verwenden autodoc. Wenn ich mein Projekt konfiguriere, wähle ich die Option "Erweiterung autodoc", aber jetzt, wenn ich benutze .. autoclass:: Class Ich erhalte eine Fehlermeldung: ERROR: Unknown directive type "autoclass" Ich konfiguriere das PYTHONPATHund jetzt ist es gut. Aber …
4
Wie kann man Rückrufe mit jsdoc richtig dokumentieren?
Ich habe eine ganze Weile im Internet nach dem besten Weg gesucht, Rückrufe mit jsdoc richtig zu dokumentieren, aber leider habe ich noch keinen großartigen gefunden. Hier ist meine Frage: Ich schreibe eine Node.js-Bibliothek für Entwickler. Diese Bibliothek bietet mehrere Klassen, Funktionen und Methoden, mit denen Entwickler arbeiten werden. Um …
Durch die Nutzung unserer Website bestätigen Sie, dass Sie unsere Cookie-Richtlinie und Datenschutzrichtlinie gelesen und verstanden haben.
Licensed under cc by-sa 3.0 with attribution required.