python-sphinx

1Hitze

1Antwort

Wie erstelle ich einen Link zur lokalen index.html aus der Sphinx-Dokumentation?

Ich schreibe ein paar Dokumente für Sphinx/rst. Wie kann ich auf der lokalen Festplatte eine Verknüpfung herstellen, die sich auf die angezeigte Seite bezieht? Zum Beispiel: ==================== My A

1Hitze

1Antwort

Python Sphinx/Rest Substitution für lange Namen zu definieren Substitutionsregel in der gleichen Quelldatei

Beitrag Python Sphinx referencing long names zur Verfügung gestellt eine Antwort, die sehr nahe war, was ich in Bezug auf Substitutionsrichtlinien für lange Klassennamen suchte. In dem Beispiel, das b

1Hitze

1Antwort

Embed Ipython Notebook in Sphinx Dokument

Ich schreibe das API-Dokument für mein eigenes Projekt. Und ich fand, dass diese coole documentation (Yt-Projekt) ipython Notebook direkt verwendet, um Beispiel zu geben. Als ich in ihre Dokumentation

2Hitze

1Antwort

Kann Django REST Swagger verwendet werden, um statische HTML-Dokumentation zu generieren?

Ich arbeite an einem neuen Django REST Framework Projekt und ich benutze Django REST Swagger, um schöne Dokumentation von Anfang an zu bieten. Allerdings möchte ich diese Dokumentation teilen, ohne ei

0Hitze

1Antwort

Unterdrücken Hyperlinks von Matplotlib Sphinx-Erweiterung

Ich verwende die matplotlib.sphinxext.plot_directive Erweiterung für sphinx, um einige Diagramme dynamisch in einigen Dokumentationen zu erstellen. In einem meiner .rst Dateien habe ich den folgenden

0Hitze

1Antwort

Fehler bei Hosting ReadTheDocs im Haus Server in python3

Ich versuche readthedocs in lokalen System (Ubuntu 14.04) in python3 virtuellen env von den Anweisungen in diesem link gegeben zu installieren Wenn ich lief PIP3 -r Anforderungen installieren. txt, ic

1Hitze

1Antwort

Bild im Literal-Block

Ich versuche, eine Verzeichnisdarstellung in meiner Dokumentation zu haben, die Bilder hat, um anzuzeigen, wenn etwas ein Ordner ist. Zur Zeit benutze ich den Literal-Block, um die schönen monospaced

0Hitze

1Antwort

Ist es möglich, die Tiefe der Sphinx-Suchseite zu erhöhen?

Das obige Bild ist die Suchfunktion des Sphinx-Dokumentationsgenerators. Wie Sie auf dem Bild sehen können, zeigt die Suchseite nicht die 'Objekte' unter Definitions und Orders an. Gibt es eine Einste

1Hitze

2Antwort

Wie erstelle ich Dokumentation von Gurke/Gurke?

Ich mag die Idee von relishapp.com, d. H. Dass Sie Gurke/Gurke Funktionen haben und Sie "lebende Dokumente" von ihnen generieren. Allerdings ist das Relish SaaS is awful. Ich bin auf der Suche nach ei

0Hitze

1Antwort

Kommentiert Sphinx toctree

Die übliche Verwendung von toctree in Sphinx etwa wie folgt aussieht: .. toctree:: :maxdepth: 2 foo bar baz und wenn zum Beispiel foo.rst beginnt mit einem Titel Überschrift "Be