Suchergebnisse für Anfrage "python-sphinx"
Sphinx autodoc ist nicht automatisch genug
Ich versuche, mit Sphinx ein Projekt mit mehr als 5.000 Zeilen in Python zu dokumentieren. Es verfügt über ca. 7 Basismodule. So weit ich weiß, muss ich für jede Datei in meinem Projekt folgenden Code schreiben, um Autodoc verwenden ...
Was ist diese "generierte" Option in der Sphinx-Autosummary-Direktive?
Ich verwende die Erweiterungen "sphinx api-doc" und "autosummary", um eine API für eine Bibliothek zu dokumentieren, und kann den Zweck von @ nicht wirklich verstehegenerated/ Option unten: .. autosummary:: :nosignatures: :toctree: generated/ ...
Sphinx, Aktualisierung der API
Das Schema ist das folgende. Es gibt ein Paket namensfoo (eine API in intensiver Entwicklung, in den ersten Alpha-Phasen), derenrst Dateien werden automatisch mit @ generiesphinx-apidoc. Um eine bessere Dokumentation für @ zu habfoo Nachdem ...
Wie habe ich mehrere Versionen meines Dokuments mit Sphinx?
Wie in der Dokumentation zu Python oder Django, wie habe ich mehrere Versionen meines Dokuments mit Sphinx? Ich habe mein Dokument in git gespeichert und möchte, dass mein Benutzer die Dokumentation für eine andere Version wie @ sehen ...
Sphinx automodule funktioniert offline, aber nicht über readthedocs.org
Ich kann nicht scheinen, ReadTheDocs zu veranlassen, irgendwelche Module zu zeigen: members :, zum Beispiel in meinem lokalen HTML, das ich erhalte: MODULE module.Beta(r, theta, beta) evaluates Beta at point Aber nach dem Drücken auf Github sagt ...
Include eine Textdatei * wie sie ist * in (Python) Sphinx Docs
(mit dem Python-Sphinx-Dokumentationswerkzeug) Ich habe ein.txt Log-Datei, in die ich einbauen möchte_build/html unveränder. Was muss ich in @ ändeconf.py, index.rst, etc Hier ist das Layout: src/ index.rst some_doc.rst somefile.txtWie ...
Kann sphinx napoleon document function mehrere Argumente zurückgeben?
Ich versuche, den Google-Codestil zu verwenden, um eine Funktion zu dokumentieren, für die ich dann Sphinx mit der Napoleon-Erweiterung verwende, um eine Dokumentation zu erstellen. Die Funktion ist insofern ungewöhnlich, als sie zwei Argumente ...
Vorlagen für `sphinx-apidoc` anpassen
Ich habe kürzlich versucht mit sphinx-apidoc [http://sphinx-doc.org/man/sphinx-apidoc.html] vonSphin [http://sphinx-doc.org/] , um Sphinx-spezifischen reStructuredText über die API eines Python-Projekts zu generieren. as Ergebnis, das ich ...
Wie verwende ich Sphinx Automodule und exponierte Funktionen in __init __
Ich habe eine Ordnerstruktur, die wie folgt aussieht: project/ mymodule/ __init__.py m1.py m2.py sub1/ __init__.py s1.py s2.py mymod/__init__.py: """The __init__ docstr""" from m1 import * from m2 import *mymod/m1.py: """m1 doc str""" def ...
Versionsnummer in Dateilinks in Sphinx verwenden
In Sphinx können Dateilinks mit der folgenden Syntax generiert werden: `name_of_file.js <some/location/name_of_file.js>`_In der Datei conf.py wird einversionie Variable @ ist so definiert, dass wir sie in den .rst-Dateien verwenden ...