python-sphinx, Seitenzahl 3

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

Wie kann ich mit Sphinx eine Dokumentation für einen Python-Property-Setter erzeugen?

Ich habe eine Python-Klasse, etwa so etwas wie die folgende, mit Docstrings, die von Sphinx in eine Dokumentation konvertiert werden sollen: %Vor% Die Sphinx-Ausgabe sieht ungefähr so aus: Klasse Richtung (Name) Eine Richtung...

04.07.2013, 21:00

Antwort

Überschreibe die Funktionsdeklaration in autodoc für sphinx

Ich habe ein Modul, das ungefähr so aussieht: %Vor% ... und ich habe eine .rst -Datei, die ungefähr so aussieht: %Vor% Wenn ich die Dokumentation erstelle, erhalte ich eine HTML-Datei mit einem Ausschnitt, der so aussieht: m...

22.08.2012, 23:03

Antworten

Thumbnail-ähnliches Verhalten mit dem Zielattribut der image-Anweisung

Ich benutze Sphinx, um ein paar Dokumente zu erstellen. Ich habe ein reStructuredText-Dokument und möchte ein Bild einfügen. Der Fall ist, dass das Bild anklickbar sein sollte, sodass, nachdem ein Benutzer auf das Bild geklickt hat, dieses Bild...

28.09.2012, 08:21

Antworten

Wie kann ich Python / Sphinx Dokumentobjektattribute nur in init deklarieren?

Ich habe Python-Klassen mit Objektattributen, die nur als Teil der Ausführung des Konstruktors deklariert sind: %Vor% Wenn ich jetzt entweder help(Foo) verwende oder versuche, Foo in Sphinx zu dokumentieren, werden die Attribute self....

18.10.2010, 13:25

Antworten

Ein Literal "*" in RestructuredText

Ich betrachte diesen Codeschnipsel: %Vor% Und sobald ich Sphinx betreibe, bekomme ich den ach so hilfreichen Fehler: %Vor% Also habe ich param ''*''args , param :literal:'*' args ausprobiert und trotzdem die Warnung erhalten. Wi...

26.05.2015, 09:23

Antwort

Python-Sphinx: Link zu Sektion in externer Datei

Ich möchte einen Abschnitt in einer externen Datei verlinken, aber ich kann es nicht zum Laufen bringen. Das :ref: scheint nicht global zu funktionieren, oder verwende ich es falsch? %Vor% %Vor% Wie kann ich auf Abschnitte aus einer...

09.01.2012, 19:34

Antworten

Gibt es in Sphinx / Pygments eine Möglichkeit, eine oder mehrere Codezeilen in literalen Includes hervorzuheben?

In einigen Sphinx-Dokumenten schreibe ich Code-Beispiele aus einer Zusatzdatei wie folgt: %Vor% Dieses spezielle Dokument ist ein Tutorial, in dem die Klassen Schritt für Schritt aufgebaut werden. Ich möchte die gesamte Klasse oder eine einz...

18.03.2010, 20:41

Antworten

Behalten Sie die Standardargumente der eingepackten / dekorierten Python-Funktion in der Sphinx-Dokumentation bei

Wie kann ich *args und **kwargs durch die echte Signatur in der Dokumentation dekorierter Funktionen ersetzen? Nehmen wir an, ich habe die folgende Dekoration und dekorierte Funktion: %Vor% Entsprechend ruft uns print(myfunc(3, 4))...

06.02.2015, 13:25

Antwort

wie man Metadaten in Python-sphinx (das Dokumentationswerkzeug) einfügt

Ich möchte einige Metadaten (d. h. Schlüsselwörter, Beschreibung, Autor) in meine von Sphinx erstellten Webseiten einfügen. Ich habe gefunden %Vor% in der Dokumentation von Sphinx, aber ich habe keine Ahnung, wie man es benutzt. Bitte...

10.01.2013, 06:47

Antwort

Wie setze ich Sphinx und latexpdf toc?

Ich habe ein Vanilla Sphinx Projekt (Sphinx 1.2b3.) erstellt mit "sphinx-quickstart" Ich füge eine grundlegende page.rst mit 4 Kopfebenen hinzu. Ich kann die Tiefe des HTML-Toks in index.rst steuern: %Vor% Basierend auf der Dokumentati...

19.11.2013, 13:50