python-sphinx

8Hitze

1Antwort

Aufschalten Funktionsdeklaration in Autodoc für Sphinx

Ich habe ein Modul, das etwas geht: #!/usr/bin/env python #: Documentation here. #: blah blah blah foobar = r'Some really long regex here.' def myfunc(val=foobar): '''Blah blah blah'''

9Hitze

3Antwort

Komprimieren von JS und CSS in statischen HTML-Dateien

Die Ausgabe von Sphinx, der 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: <link rel="

6Hitze

2Antwort

Führt Sphinx meinen Code beim Ausführen von 'make html' aus?

Ich habe eine ziemlich große Codebasis geerbt, für die ich eine HTML-Dokumentation erstellen möchte. Da es in Python geschrieben ist, habe ich mich für sphinx entschieden, da die Benutzer des Codes an

5Hitze

1Antwort

Haben replace Sphinx Text Docstring

Ich bin Code in Sphinx dokumentieren, dass dies ähnelt: class ParentClass(object): def __init__(self): pass def generic_fun(self): """Call this function using /run/ParentClass/

13Hitze

1Antwort

So erstellen Sie benutzerdefinierte Anweisungen in Sphinx

Ich dokumentiere derzeit eine Rest-API in Python geschrieben. Die gesamte Projektdokumentation wird mit Sphinx erstellt, und für die REST-API möchte ich einige spezielle Anweisungen erstellen. Nehmen

5Hitze

1Antwort

Wie ändert man die <head> in Sphinx-Dokumentation, so dass die relativen Links aktualisiert werden?

Ich benutze Sphinx, um ein Python-Projekt zu dokumentieren. Ich verwende die Zeichenfläche, um einige Ergebnisse in der Dokumentation zu visualisieren. Meine Dokumentation muss Firefox und IE unterstü

5Hitze

3Antwort

Kann der XeLaTeX-Builder mit Sphinx verwendet werden?

Obwohl das Ende-Problem, dass dies zu lösen wäre ein TeX (eine neue Schriftart für PDF-Ausgabe installieren), diese spezielle Lösung, die ich suche, ist ein Sphinx-Problem. Sphinx verwendet Standard-L

29Hitze

3Antwort

Fett kursiv in ReStructuredText

Ich schreibe einige Dokumentation mit ReStructuredText (ReST) -Format für die spätere Web-Seite Generation mit Sphinx, und ich kann keine Möglichkeit finden, einige "fett kursiv" Text zu schreiben. Es

9Hitze

1Antwort

So erstellen Sie nur eine Datei mit sphinx

Für eine schnelle Vorschau möchte ich nur eine Datei und nicht das gesamte Projekt erstellen. Es ist möglich mit Sphinx? Vor kurzem habe ich so etwas wie: sphinx-build -b html documentation/ doc_html

7Hitze

2Antwort

Sphinx: Liste der unterstützten Sprachen zum Hervorheben?

Ich benutze Sphinx für Code-Dokumentation und verwenden mehrere Sprachen innerhalb des Codes, ich möchte markieren für diesen Code. Sphinx erwähnt kurz einige der Sprachen, die es unterstützt (on this