python-sphinx, Seitenzahl 4

Sphinx ist ein Werkzeug, mit dem Sie einfach und intelligent Dokumentation erstellen können. Sphinx ist besonders für die Python-Dokumentation geeignet, aber es ist ein universelles Werkzeug, mit dem man alles dokumentieren kann.

Antwort

Sphinx fügt einen Link zu einem Bild oder einer Figur hinzu

Ich versuche etwas ziemlich Grundlegendes in Sphinx. Ich habe einige Bilder, aber ich bevorzuge es, sie ziemlich klein zu halten, und ich möchte dem Benutzer erlauben, auf sie zu klicken, um das größere Bild zu erhalten. Ich finde keine syntakti...

01.12.2012, 17:32

Antworten

sphinx importiert die erste Datei?

Ich muss für jedes Modul ein Sphinx-Projekt erstellen, und jedes Modul teilt einige gemeinsame rtsts, wie Unternehmensinformationen, Lizenzen usw. Mein Projektbaum ist wie folgt: %Vor% Ich schreibe das in ./device1/index.rst, und es is...

29.12.2010, 00:35

Antworten

Sphinx-TOC-Baum modifizieren

Ich habe ein Sphinx-Projekt mit einem Inhaltsverzeichnis ( index.rst ), die :maxdepth: 2 enthält. Das Problem ist, ich möchte die Tiefe auf 1 für den Abschnitt release reduzieren, so dass es die Liste der Versionshinweise im Haupt-T...

10.11.2015, 18:48

Antworten

Sphinx erstellt uncodierte Codeblöcke in der PDF-Ausgabe

Codeblöcke sehen in der PDF-Ausgabe hässlich aus (überprüfen Sie die Anführungszeichen): Ich benutze Version 1.1.3 von Sphinx und benutze den folgenden Befehl, um das Dokument zu erstellen: %Vor% Wenn Sie das Snippet aus der PDF-Datei...

22.04.2013, 23:49

Antwort

Wie habe ich mehrere Versionen meines Dokuments mit sphinx?

Wie habe ich, wie die Dokumentation von Python oder Django, mehrere Versionen meines Dokuments mit sphinx? Ich habe mein Dokument auf git gespeichert und möchte, dass mein Benutzer die Dokumentation für verschiedene Versionen wie v2.7 , v3...

04.03.2015, 08:02

Antwort

Sphinx toctree zeigt entweder ein Inhaltsverzeichnis in der Seitenleiste mit einer Aufzählungsliste im Hauptteil oder gar nichts an

Ich arbeite mit Sphinx (sphinx-1.2b1-py2.7). Ich möchte, dass ein Inhaltsverzeichnis in einer Seitenleiste angezeigt wird. Es scheint binär: Ich kann nur ein Inhaltsverzeichnis in der Seitenleiste und eine Aufzählung im Textkörper erhalten, oder...

19.06.2013, 14:49

Antworten

Erzwingen, dass in reStructuredText in der Code-Umgebung nicht-brechender Platz erzwungen wird?

Ich habe diesen Ausschnitt in meinem reStructuredText-Dokument: %Vor% Beachten Sie die Code / Zitat-Umgebung. Beachten Sie den Abstand zwischen Google und Drive im Pfad. Wenn mit Sphinx in HTML gerendert wird, gibt es einen Zeilenum...

19.05.2016, 14:13

Antworten

Sphinx: Korrekte Art, eine Enum zu dokumentieren?

Beim Durchsehen der C- und C ++ - Domänen von Sphinx scheint es keine native Unterstützung für die Dokumentation zu geben enums (und viel weniger anonym enums). Ab sofort benutze ich cpp:type:: für den Enum-Typ, und dann eine Liste aller mö...

17.07.2013, 03:10

Antwort

Die Sphinx-Dokumentationsprozessor-Erweiterung funktioniert anders für die HTML- und LaTeX-Ausgabe?

Ich habe eine einfache Sphinx-Erweiterung wie folgt: %Vor% Gegeben ein Dokument mit %Vor% Die HTML-Ausgabe enthält »Test: bar«, aber die LaTeX-Ausgabe enthält »Test:?« (der Standardwert). Ich habe überprüft, dass node['foo'] nach der...

15.11.2012, 01:24

Antwort

Verspotten von Python-Iterablen für die Verwendung mit Sphinx

Ich benutze Sphinx, um ein Projekt zu dokumentieren, das von wxPython abhängt, mit der Erweiterung autodocs , so dass es automatisch Seiten aus unseren Docstrings generiert. Die Erweiterung autodocs funktioniert automatisch auf jedem Modul, d...

18.12.2013, 18:54