python-sphinx

11Hitze

2Antwort

Wie erzwingen Sie beim Erstellen von HTML-Dokumentation, Sphinx zu melden, oder erstellen Sie einen Fehler, auf Links, die nicht existieren? Insbesondere habe ich Eigenschaften und Methoden in meinem

10Hitze

1Antwort

Referenzieren von Parametern in einem Python-Docstring

Ich benutze Sphinx und die Autodocs-Funktion, um sicherzustellen, dass wir gute Dokumente in unserem Projekt haben. Also ich bin vertraut mit info field lists und ich bin vertraut mit der Verwendung c

7Hitze

1Antwort

Auflösen von Namenskonflikten in Referenzen in Sphinx mit intersphinx

Ich schreibe Dokumente für meine Python-Bibliothek Mit Sphinx habe ich auch eine weitere Sphinx-Dokumentation mit intersphinx hinzugefügt. Und es funktioniert ziemlich gut, aber ein paar meiner Funkti

5Hitze

1Antwort

Sphinx Methode Rückgabetypen mit Links

Mit cython zusammen mit -Xembedsignature=True Signaturen in Docstrings in Form ergeben kann: | mymethod(...) | MyCythonModule.mymethod(self, param1, MyCythonType param2, param3=None) -> SomeResultTy

6Hitze

3Antwort

Sphinx-Dokumentation in einer laufenden Flask-Web-Anwendung

Ich habe statische Sphinx-Dokumentationen lokal erstellt (mit make html). Ich möchte jetzt die Sphinx-Dateien in meine Webapp integrieren, die mit Flask läuft. Von der Flask Running-Anwendung möchte i

11Hitze

1Antwort

Kann TOCTREE in Sphinx nicht erhalten, um Verbindung anzuzeigen

Ich bin zu Sphinx neu. Ich habe das Tutorial ausprobiert, aber ich konnte den Link im Inhalt nicht erzeugen. Der Fehler, ich habe C:\Users\mhaikalm\sphinxtest\source\index.rst:11: WARNING: toctree con

12Hitze

1Antwort

Wie sphinx-generierte Dokumentation automatisch auf bitbucket Wiki veröffentlicht?

Ich habe ein Python-Paket mit Sphinx-generierte Dokumentation (mit der Automodules-Funktion) und es kann zu einer Reihe von statischen HTML-Seiten in einem _build-Verzeichnis im Git-Repository des Pro

9Hitze

1Antwort

Python: Sphinx: Wie automatisch alle Klassen, Methoden und Funktionen in einer Sphinx-Dokumentation enthält?

Mögliche Duplizieren: Sphinx — combining automodule and autoclass ich versuche, eine HTML-Dokumentation für ein Projekt zu erstellen mehrere tausend Klassen enthalten Sphinx verwenden und es ist Autod

6Hitze

4Antwort

Bedingte Toctree in Sphinx

Ich möchte mehrere Versionen einer Dokumentation, die sich in den Abschnitten, die enthalten sind, unterscheiden. Um dies zu erreichen, verwende ich normalerweise entweder die only Direktive oder die

6Hitze

4Antwort

Ausblenden von Sphinx-Unterabschnitten aus dem Haupt-TOCTree

Ist es möglich, einen (oder alle) in einer RST-Datei vorhandenen Unterabschnitte im Haupt-TOCTree auszublenden? Lassen Sie mich ein wenig mehr beschreiben: index.rst :doc:`Label <path/to/rst/file>` ^