python-sphinx

10Hitze

1Antwort

sphinx streng: unerwartete Abschnitt Titel - beliebige Überschriften in der Funktion docstring

Verwendung autodoc und ähnliche Tools können Sie eine Dokumentation aus der Quelle Docstrings kompilieren. Es ist jedoch nicht, scheint willkürlich ReST Abschnittstitel in Funktion oder Klasse Docstri

6Hitze

1Antwort

Sphinx Napoleon Extension: Dokumentieren Sie mehrere Argumente mit Google Style Docstrings

Diese Frage bezieht sich auf this other one. Die vorgeschlagene und akzeptierte Lösung ist: Diese Lösung funktioniert nicht, zumindest für mich. Der eingerückte Unterblock mit arg1 und arg2 Beschreibu

13Hitze

2Antwort

Ist es möglich, Python-Funktionsargumente in Sphinx zu verstecken?

Angenommen, ich habe die folgende Funktion, die in den Numpydoc style dokumentiert ist, und die Dokumentation automatisch generierte mit dem Sphinxautofunction directive: def foo(x, y, _hidden_argumen

15Hitze

3Antwort

mehrzeilige Beschreibung eines Parameters Beschreibung in Python docstring

So ist reStructuredText the recommended way für Python-Code Dokumentation, wenn man hart genug versuchen, können Sie find in the sphinx documentation , wie Sie Ihre Funktion Unterschrift Dokumentation

13Hitze

3Antwort

Sphinx: ivar-Tag sucht nach Querverweisen

Ich möchte Python-Objektattribute mit Sphinx dokumentieren. Ich verstehe, soll ich :ivar varname: description :ivar type varname: description verwenden aber ich ein seltsames Verhalten zu sehen bin

5Hitze

2Antwort

Anpassen von Sphinx zur Vermeidung der Generierung von Suchfeldern

Gibt es einen einfachen Weg (d. H. Ohne ein völlig neues Thema zu erstellen), um Sphinx so anzupassen, dass es HTML-Seiten ohne das Suchfeld generiert?

6Hitze

1Antwort

eine CSS-Klasse in RST auf einen Link hinzufügen

Ich habe einen Link in meiner .rst-Datei, die Dies macht wie Click me! <../link_reference.html> sieht mich als Klicken !. Ich möchte jedoch eine CSS-Klasse hinzufügen, sodass es wie Click me! Aussie

5Hitze

2Antwort

LaTeX Fehler bei der Sphinx: Datei `titlesec.sty‘ nicht gefunden

Bei dem Versuch, die PDF-Dokumentation eines Sphinx-Projekt zu generieren, bekomme ich diese: ! LaTeX Error: File `titlesec.sty' not found. Type X to quit or <RETURN> to proceed, or enter new name.

7Hitze

1Antwort

Kann nicht verwendet werden Ref mit einem Label mit Sphinx doc

Ich habe ein Problem mit Sphinx-Docs Ref-Funktion, ich lege eine Beschriftung über einen Absatz und dann versuche ich auf dieses Etikett von einem anderen Dokument aber innerhalb des gleichen Projekts

8Hitze

2Antwort

Ein wörtliche "*" in RestructuredText

Ich betrachte diesen Code-Snippet: def ook(*args): """Some silly function. :param *args: Optional arguments. """ ... Und sobald ich Sphinx laufen lasse, erhalte ich die ach so h