Sphinx ist ein Tool, mit dem Sie auf einfache Weise intelligente und schöne Dokumentationen erstellen können. Sphinx eignet sich besonders für die Python-Dokumentation, ist jedoch ein universelles Tool, mit dem alles dokumentiert werden kann.
Ich hasse RST, aber ich liebe Sphinx. Gibt es eine Möglichkeit, wie Sphinx Markdown anstelle von reStructuredText
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:...
Wie füge ich einen Querverweis in eine reST / Sphinx-Seite ein, entweder in einen Unterheader oder in einen Anker auf einer anderen Seite im selben
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...
Ich versuche mit Sphinx zu beginnen und habe unerbittliche Probleme. Befehl: docs/sphinx-quickstart Ich beantworte alle Fragen und alles funktioniert gut. Befehl: docs/ls Alles sieht normal aus. Ergebnis:build Makefile source Befehl: sphinx-build -d build/doctrees source build/html Es...
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...
Geschlossen . Diese Frage muss fokussierter sein . Derzeit werden keine Antworten akzeptiert. Möchten Sie diese Frage verbessern? Aktualisieren Sie die Frage so, dass sie sich nur auf ein Problem konzentriert, indem Sie diesen Beitrag bearbeiten . Geschlossen vor 2 Jahren . Verbessere diese Frage...
Ich versuche, eine ordnungsgemäß verschachtelte Liste mit dem folgenden Code zu erstellen ( gemäß den Dokumenten von Sphinx und docutils ): 1. X a. U b. V c. W 2. Y 3. Z Ich erwarte, dass dies zu zwei OLSekunden führt, aber ich erhalte stattdessen die folgende Ausgabe: <ol class="arabic...
Ich verwende Sphinx, um ein Nicht-Python-Projekt zu dokumentieren. Ich möchte ./docOrdner in jedem Submodul verteilen , die submodule_name.rstDateien enthalten , um dieses Modul zu dokumentieren. Ich möchte diese Dateien dann in die Master-Hierarchie einfügen, um eine Spezifikation für das gesamte...
Ich möchte einen Link zu einer Methode in meiner Klasse aus der Dokumentzeichenfolge einer anderen Methode derselben Klasse hinzufügen. Ich möchte, dass der Link in Sphinx und vorzugsweise auch in Spyder und anderen Python-IDEs funktioniert. Ich habe mehrere Optionen ausprobiert und nur eine...
Wie formatieren Sie Text innerhalb eines angegebenen Links in reStructuredText? Insbesondere möchte ich aus meinem ersten HTML-Code Folgendes generieren: <a href="http://docs.python.org/library/optparse.html"><tt>optparse.OptionParser</tt> documentation
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"...
Die Erstellung von Sphinx-Dokumenten auf Read-the-Docs schlägt mit dem folgenden Fehler fehl (vollständiges Protokoll unten): ImportError: cannot import name 'PackageFinder' from 'pip._internal.index'
Bitte laden Sie die Datei herunter simple.7zund installieren Sie sie in Ihrer Sphinx, um die hier beschriebenen Probleme zu reproduzieren. Um sie zu reproduzieren, können Sie Folgendes ausführen: make clean make html Laden Sie es herunter und installieren Sie es in Ihrer Sphinx, um Probleme zu...