python-sphinx

10Hitze

1Antwort

Auslassen (oder formatieren) des Wertes einer Variablen beim Dokumentieren mit Sphinx

Ich dokumentiere gerade ein ganzes Modul mit autodoc. Ich definiere jedoch mehrere Variablen auf der Modulebene, die lange Listen oder Dicts enthalten. Sie sind in der Dokumentation zusammen mit den W

22Hitze

3Antwort

Sphinx und argparse - Autodocumentation Befehlszeilenskripte?

Ich baue ein Python-Paket und benutze Sphinx, um die Dokumente zu erstellen. Abgesehen von meinem Paketcode schließe ich auch viele Python-Skripte ein, die argparse verwenden. Ich habe mich gefragt, o

52Hitze

5Antwort

Kann Sphinx auf Dokumente verlinken, die sich nicht in Verzeichnissen unter dem Stammdokument befinden?

Ich benutze Sphinx, um ein Nicht-Python-Projekt zu dokumentieren. Ich möchte ./doc Ordner in jedem Submodul verteilen, das submodule_name.rst Dateien enthält, um dieses Modul zu dokumentieren. Ich möc

44Hitze

1Antwort

Neuinstallation von sphinx-quickstart schlägt fehl

Der erste Versuch mit Sphinx, mit einer sauberen Installation von Sphinx 1.1.3 und einem Shinx-Schnellstart fehlgeschlagen zu sein. Sollten Abhängigkeiten installiert sein? Ich habe versucht, pip --fo

13Hitze

3Antwort

Bildraster in reStructuredText/Sphinx

Ich benutze Sphinx, um Dokumentation für ein Python-Projekt zu erstellen, an dem ich gerade arbeite. Ich habe drei Bilder, die ich in einem 1x3-Raster anzeigen möchte (d. H. Alle in derselben Zeile),

50Hitze

7Antwort

sphinx-build fail - autodoc kann das Modul nicht importieren/finden

Ich versuche mit Sphinx anzufangen und habe scheinbar unbarmherzige Probleme. Befehl: docs/sphinx-quickstart ich alle Fragen beantworten und alles funktioniert. Befehl: docs/ls Alles sieht normal. Erg

5Hitze

1Antwort

Autoklassen- und Instanzattribute

Gemäß der sphinx documentation sollte die Direktive .. autoattribute in der Lage sein, Instanzattribute zu dokumentieren. Allerdings, wenn ich tue :: .. currentmodule:: xml.etree.ElementTree .. auto

6Hitze

1Antwort

Warum verwendet CPython `sphinx.autodoc` nicht für die Standardbibliothek?

Ich entwickle eine Python-Bibliothek und ich verwende sphinx.autodoc, um die Dokumentation zu generieren, da ich denke, dass dies ein guter Weg ist, sich nicht zu wiederholen und Dokumentation und Cod

3Hitze

1Antwort

Verwenden von '\ displaymath' Direktiven in Docstrings Formeln

Ich verwende das Sphinx-Dokumentationspaket, um ein kleines Python-Toolkit zu dokumentieren, an dem ich arbeite, und ich möchte die mathematischen Formeln der verschiedenen Module beschreiben, indem i

0Hitze

2Antwort

Von epydoc zu sphinx wechseln, um eine einfache Python-.py-Datei automatisch zu dokumentieren

Epydoc funktioniert nicht mehr, selbst nach dem Anwenden von Patches, also versuche ich, zu Sphinx zu wechseln. mag ich automatisch generieren Dokumentation aus einer einfachen Python-Datei: test.py N