python-sphinx, Seitenzahl 2

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.

Antworten

Kann die sphinx napoleon Dokumentfunktion mehrere Argumente liefern?

Ich versuche, den Google-Code-Stil zu verwenden, um eine Funktion zu dokumentieren, die ich dann mit sphinx mit der Napoleon-Erweiterung verwende, um Dokumentation für zu erstellen. Die Funktion ist insofern ungewöhnlich, als sie zwei Argumente...

23.03.2015, 22:21

Antwort

Wie kann ich in Sphinx einen verknüpfbaren "Terminologie" -Abschnitt ohne großen Overhead erstellen?

Ich möchte einen "Terminologie" -Abschnitt mit Definitionen für die von mir verwendeten Begriffe erstellen, sodass jedes Mal, wenn ich die Begriffe in diesem Terminologieabschnitt verwende, eine Verknüpfung erstellt wird, die auf die Definition...

21.09.2010, 19:02

Antworten

Sphinx: Wie kann man Importe in Automodule ausschließen?

Ich habe ein Himbeer-Pi-Projekt in Python geschrieben, das RPi.GPIO-Modul verwendet. Die ganze Arbeit am Code wird in einem Windows-Feld ausgeführt, in dem RPi.GPIO nicht installiert wird und jedes Mal, wenn ich versuche, autodoc auszuführen, st...

08.04.2013, 21:48

Antworten

Python Sphinx verweist auf lange Namen

Ich arbeite an der Dokumentation für mein Python-Modul (mit Sphinx und reST), und ich finde, dass beim Querverweisen auf andere Python-Objekte (Module, Klassen, Funktionen, usw.) der vollständige Objektname unglaublich ist lange. Oft sind es meh...

05.04.2012, 18:52

Antwort

Sphinx erzeugt eine leere Dokumentation

Ich versuche, mit Sphinx eine Dokumentation für mein Projekt zu erstellen, aber die Ausgabedokumentation enthält keine meiner Klassen. Was mache ich falsch? Im Folgenden sind die Befehle, die ich verwende, um Dokumentation zu generieren: %Vor%...

11.11.2012, 16:42

Antwort

Wie richte ich benutzerdefinierte Stile für reStructuredText, Sphinx, ReadTheDocs usw. ein?

Ich möchte das von Sphinx und ReadTheDocs verwendete Thema mit meinen eigenen benutzerdefinierten Stilen erweitern. Was ist der beste Weg, dies zu tun, damit meine Änderungen bleiben?

18.08.2015, 17:42

Antwort

Entfernen Sie den Paket- und Modulnamen aus der sphinx-Funktion

ist es eine Möglichkeit, das Paket und / oder den Modulnamen von sphinx doc zu entfernen? Beispiel: Wenn im Modul foo.bar eine Funktion namens waa existiert, dann der erste Code %Vor% erzeugt %Vor% und ich möchte ausgeben %Vor%

31.12.2013, 23:59

Antworten

Wie ändert man die Codebeispiel-Schriftgröße in LaTeX PDF-Ausgabe mit sphinx?

Ich finde die Standardcodebeispielschrift in der von sphinx erzeugten PDF viel zu groß. Ich habe versucht, meine Hände in der erzeugten .tex-Datei schmutzig zu machen, indem ich Schriftgrößenbefehle wie \tiny über den Codeblöcken einfüge,...

27.03.2012, 23:43

Antworten

Wie kann ich eine Intersphinx-Verknüpfung zu einer beliebigen Methode in der Standardbibliotheksdokumentation einfügen?

Ich versuche Sphinx zu benutzen, um ein Projekt zu dokumentieren, aber ich kann nicht herausfinden, wie ich es benutzen soll Intersphinx. Ich benutze diese Zeile: %Vor% fügt den Link hinzu, aber in der Ausgabe wird er fett angezeigt, nicht a...

25.05.2011, 19:42

Antworten

HTML-Seitenvorlage für ein bestimmtes Sphinx-Dokument überschreiben

Ich implementiere eine Dokumentation mit Sphinx ( Ссылка ) & amp; möchte die HTML-Seite eines bestimmten Dokuments überschreiben. Mein Interesse ist es, alle Verzeichnisindizes zu überschreiben, um nicht nur eine einfache ul. anzuzeigen Ich h...

03.11.2012, 13:23