Suchergebnisse für Anfrage "python-sphinx"

8 die antwort

Wie schreibe ich Querverweise auf externe Dokumentation mit intersphinx?

Ich versuche, Querverweise auf externe APIs in meine Dokumentation aufzunehmen, aber es treten drei verschiedene Verhaltensweisen auf. Ich verwende Sphinx (1.3.1) mit Python (2.7.3) und meine Intersphinx-Zuordnung ist wie folgt ...

6 die antwort

Sphinx: ivar-Tag sucht nach Querverweisen

Ich möchte Python-Objektattribute mit Sphinx dokumentieren. Ich verstehe, ich sollte @ verwend :ivar varname: description :ivar type varname: description Wie auch immer ich ein seltsames Verhalten sehe, Sphinx durchsucht mein Projekt nach ...

2 die antwort

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

Ich möchte das von @ verwendete Thema erweiteSphin und ReadTheDocs mit meinen eigenen benutzerdefinierten Stilen. Was ist der beste Weg, damit meine Änderungen erhalten bleiben?

TOP-Veröffentlichungen

2 die antwort

Kann Ref nicht mit einem Label mit Sphinx doc verwenden

Ich habe ein Problem mit der Verwendung der Ref-Funktion von Sphinx-doc. Ich platziere eine Beschriftung über einem Absatz und versuche dann, eine Verknüpfung zu dieser Beschriftung aus einem anderen Dokument zu erstellen, das sich jedoch im ...

4 die antwort

Download HTML als separate Seiten

Ich verwende Read The Docs für ein Projekt. Alles scheint online gut zu funktionieren. Wenn ich jedoch den HTML-Code für die Offline-Verwendung herunterlade, wird die gesamte Dokumentation in einer einzigen HTML-Datei (index.html) ...

4 die antwort

Eine Klasse zu einer Tabelle in Sphinx hinzufügen?

Ich habe eine Tabelle in rst und möchte ihr eine Klasse hinzufügen, wenn ich mit Sphinx HTML kompiliere. Gemäßthe docs [http://docutils.sourceforge.net/docs/ref/rst/directives.html#class], ein @ hinzufüg.. class::ie Direktive @ vor der Tabelle ...

4 die antwort

Modify Sphinx TOC tree

Ich habe einSphinx-Projekt [https://github.com/facebook/presto/tree/master/presto-docs/src/main/sphinx] mit einem TOC index.rst) das beinhaltet:maxdepth: 2. Das Problem ist, ich möchte die Tiefe auf @ reduzier1 für dasrelease Abschnitt, sodass ...

4 die antwort

Zeigen Sie jeden Abschnitt (h1, h2, h3) auf einer neuen Seite in Sphinx an

Wenn ich eine HTML-Ausgabe mit Sphinx erstelle, ist es möglich, h1 und h2 auf separaten Seiten anzuzeigen. H3 wird jedoch immer auf derselben Seite wie h2 angezeigt. Weiß jemand, wie man Sphinx dazu bringt, den Inhalt von h3 auf einer separaten ...

0 die antwort

python Sphinx "Das Modul führt die Anweisung auf Modulebene aus und ruft möglicherweise sys.exit () auf."

Ich versuche, Sphinx für den dokumentierten Code zu verwenden. Aber ich sehe den Fehler das Modul führt die Anweisung auf Modulebene aus und ruft möglicherweise sys.exit () auf. Ich habe festgestellt, dass dieser Fehler mit dem folgenden Code ...

2 die antwort

Differenz zwischen sphinxcontrib.napoleon und numpy.numpydoc [closed]

Ich schreibe Dokumentation für ein Python-Projekt mit Numpy-style docstrings [https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt]. numpydoc [https://pypi.python.org/pypi/numpydoc] ...