python-sphinx

Ich habe ein Python-Modul, für das ich ein Tutorial schreibe, in dem ich Sphinx einschließlich Doc-Tests verwende. Dieses Modul enthält einige Hilfsprogramme. Ich möchte diese Hilfsprogramme in die Dokumentation aufnehmen und lassen Sie...

Ich habe ein Python-Projekt, das Sphinx-Dokumentation und Distutils zur Veröffentlichung in Pip hat. Beide dieser Funktionen erfordern eine Version (z. B. 0,4b3) Gibt es eine Best Practice für die automatische Verwaltung einer konsistenten...

In einer benutzerdefinierten Sphinx-Domäne möchte ich einen Verweis auf einen anderen Knoten in einer anderen Domäne erstellen. Zum Beispiel: %Vor% Mein example:directive:: sagt, dass meine "Methode" baz etwas vom Typ foo.bar zurück...

Ich habe versucht, mit nbsphinx ein Jupyter-Notizbuch einzubetten, das Plotplots enthält, aber die Plots erscheinen nicht in der Dokumentation, obwohl sie auf dem Jupyter-Notebook gut aussehen. Wie kann ich ein Plotly-Diagramm in die Sphinx-D...

Ich verwende Sphinx für die Dokumentation eines Python-Projekts und hätte gerne den Inhalt einer vorhandenen .md -Datei in einer .rst -Datei. (Ich habe meine conf.py bereits eingerichtet, um Abschläge zuzulassen). Zum Beispiel hab...

Ich habe eine dreischichtige Klassenstruktur wie folgt: %Vor% Meine index.rst -Datei sieht wie folgt aus: %Vor% Sphinx erzeugt eine nette API-Dokumentation für mich. Es enthält die Klassen Super und Sub mit den entsprechenden Ko...