Als «python-sphinx» getaggte Fragen

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.

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?
6
Kann Sphinx Links zu Dokumenten erstellen, die sich nicht in Verzeichnissen unterhalb des Stammdokuments befinden?
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 Design zu erstellen. Dh: Project docs spec project_spec.rst conf.py modules …
3
Link zur Klassenmethode in Python Docstring
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 gefunden, die funktioniert, aber es ist umständlich. …
4
Formatieren Sie Text in einem Link in reStructuredText
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 documentation</a> Das Ergebnis sollte folgendermaßen aussehen: optparse.OptionParser Dokumentation Dabei befindet sich der Teil "optparse.OptionParser" in einer Schriftart mit fester Breite. Ich habe es versucht ```optparse.OptionParser`` <http://docs.python.org/library/optparse.html>`_ dies gab …
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 …
1
Read-the-Docs-Build schlägt fehl mit "Name 'PackageFinder' kann nicht aus 'pip._internal.index' importiert werden"
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' (/home/docs/checkouts/readthedocs.org/user_builds/cascade-python/envs/latest/lib/python3.7/site-packages/pip/_internal/index/__init__.py) Habe ich etwas falsch gemacht oder ist dies ein Fehler beim Lesen der Dokumente? Ein lokaler Build von Sphinx-Dokumenten läuft einwandfrei. Vollständiges Fehlerprotokoll beim Lesen der Dokumente: …
2
Warum kann die aus der ersten Datei mit Fragezeichen konvertierte HTML-Datei nicht im Browser angezeigt werden, wenn auf den Katalog geklickt werden muss?
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 reproduzieren Es gibt zwei …
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.