python-sphinx, Seitenzahl 1

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

Enthält die Spende einer anderen Seite in Sphinx

Ich habe die folgende Seite bei plugins / index.html: %Vor% plugin / basics / index.html und plugins / advanced / index.html enthalten ihre eigenen Toctrees, die auf die gleichen Unterseiten verweisen, die in plugins / index.html aufgeführt...

26.10.2012, 21:24

Antworten

Einfachste Art, Sphinx in einer Python-Datei auszuführen

Wir haben eine Sphinx-Konfiguration, die eine Menge HTML-Dokumente für unsere gesamte Codebasis generiert. Manchmal arbeite ich an einer Datei und möchte nur die HTML-Ausgabe aus dieser Datei sehen, um sicherzustellen, dass ich die Syntax richti...

21.05.2012, 20:34

Antworten

Wie fügt man Sphinx-generierten Index zur Seitenleiste hinzu, wenn Sie das Thema Docs lesen?

Ich möchte einen Link zu dem automatisch generierten Index in der Seitenleiste haben, wenn sphinx-rtd-theme verwendet wird. Ich habe versucht, es in den Baum zu fügen: %Vor% aber dies führte zu %Vor% von Sphinx und keine andere Wirkun...

11.08.2014, 12:36

Antwort

Wie man mit sphinx nur eine Datei erstellt

Für eine schnelle Vorschau möchte ich nur eine Datei und nicht das gesamte Projekt erstellen. Es ist möglich mit Sphinx? Kürzlich mache ich etwas wie: %Vor% Danke

16.08.2012, 16:54

Antworten

Komprimieren von JS und CSS in statischen HTML-Dateien

Die Ausgabe von Sphinx , dem Python-Dokumentationsgenerator, führt zu einer großen Anzahl von HTML-Dateien. Jeder hat einen Header mit einer großen Anzahl von JavaScript und CSS beinhaltet: %Vor% Die meisten davon werden einzeln minimiert,...

06.09.2012, 14:35

Antworten

RTL-Unterstützung in Python Sphinx

Gibt es eine Möglichkeit, RTL-Text (von rechts nach links, wie Farsi, Arabisch, ...) in sphinx zu verwenden? Beim Generieren von HTML aus .rst-Dateien ist das generierte HTML LTR (standardmäßig von links nach rechts) und nach links ausgeric...

30.09.2012, 12:20

Antwort

Python: Sphinx: Wie fügt man automatisch alle Klassen, Methoden und Funktionen in eine Sphinx-Dokumentation ein? [Duplikat]

Ich versuche, eine HTML-Dokumentation für ein Projekt mit mehreren tausend Klassen mit sphinx und seinem Autodoc-Plugin zu erstellen. sphinx-apidoc erzeugt wunderbare rst-Dateien, aber es fehlt die automatische Erstellung von autoclasses...

02.01.2013, 10:17

Antwort

Zeigen Sie reStructuredText (Sphinx) DocStrings in iPython an?

Gibt es eine Möglichkeit, dass IPython die DocStrings reStructuredText (für Sphinx) vollständig rendert, wenn Sie Folgendes eingeben: %Vor% oder: %Vor% Ich finde es super ablenkend, um zu versuchen, Hilfedokumente in IPython zu lesen,...

24.01.2012, 20:45

Antworten

In reStructuredText, wie wird ein Inline-Literal in einen Hyperlink eingefügt?

In meinem reStructuredText-Dokument habe ich einen Abschnitt wie folgt definiert: %Vor% Ich möchte auf diesen Abschnitt wie folgt verweisen: %Vor% Aber wenn dieser Code in HTML gerendert wird, sieht er so aus: Aktualisieren Sie die...

29.12.2015, 17:52

Antworten

Mehrere Sphinx-Dokumentationswebsites kombinieren [geschlossen]

Ich möchte mehrere Sphinx-generierte Dokumentationssites an einem einzigen Ort (Site) zusammenführen. Ich möchte die Arbeit nicht replizieren, sondern nur von einem zentralen Ort aus indexieren / suchen. Anforderungen : Durchsuchbare Dok...

05.09.2012, 00:18