python-sphinx

8Hitze

2Antwort

Ich habe eine Sphinx project mit einer TOC (index.rst), die :maxdepth: 2 enthält. Das Problem ist, ich möchte die Tiefe auf 1 für den release Abschnitt reduzieren, so dass es nicht die Liste der Versi

15Hitze

1Antwort

Wie können mehrere Typen für einen einzelnen Parameter oder einen Rückgabewert in DocStrings ausgedrückt werden, die von Sphinx verarbeitet werden?

Manchmal akzeptiert eine Funktion in Python ein Argument eines flexiblen Typs. Oder es kann einen Wert eines flexiblen Typs zurückgeben. Jetzt kann ich mich an kein gutes Beispiel für eine solche Funk

6Hitze

2Antwort

Was ist der Sinn der Sphinx highlight_language Config-Option, wenn Code-Block :: kein optionales Argument hat?

Was ist der Sinn der Sphinx highlight_language config Option, wenn Code-Block :: kein optionales Argument hat? Es sagt, dass es den Standard hightlight_language setzt, aber wenn jedes Mal, dass Sie Co

6Hitze

1Antwort

Wie man Funktionssignaturen mit Sphinx erzeugt?

Die Paketstruktur und Dateien sind wie folgt aufgebaut: $ tree . . ├── doc │ ├── Makefile │ ├── README.md │ ├── _build │ ├── _static │ ├── conf.py │ ├── foo.rst │ ├── index.rst

5Hitze

1Antwort

Was ist der Unterschied zwischen den Code- und Codeblock-Anweisungen in ReST?

In jedem Renderer habe ich versucht, code und code-block scheinen genau das gleiche Ergebnis zu haben: ein Block von Code. Beide erzeugen genau die gleiche HTML - einschließlich Klassen und Tag-Art (m

7Hitze

2Antwort

Was ist der Unterschied im Verhalten zwischen: func: und: meth: Rollen in Python Sphinx?

Die Sphinx-Dokumentation auf http://www.sphinx-doc.org/en/stable/domains.html#cross-referencing-python-objects sagt, : py: func: Referenz eine Python-Funktion; Gepunktete Namen können verwendet werden

45Hitze

1Antwort

Wie sollte ich Listen, Optionale und Erträge mit Sphinx im Google-Stil dokumentieren?

Wie kann ich Typen für Listen, optionale Argumente und Rückgabetypen für Generatoren in Google-artigen Docstrings mit Sphinx-Napoleon angeben? Ich habe versucht, List[type] list of type Optional[ty

6Hitze

1Antwort

Wie konfiguriert man Sphinx-Autokolben, um Flaschennestful-API zu dokumentieren?

Ich habe eine Flasch-App, die Sphinxs Autoflask-Direktive verwenden soll, um eine Flasch-Restful-API zu dokumentieren. https://pythonhosted.org/sphinxcontrib-httpdomain/#module-sphinxcontrib.autohttp.

10Hitze

2Antwort

Einige Module in Autodoc ignorieren

Ich versuche Autodoc nur für ausgewählte Module zu verwenden. Ich habe eine Datei erstellt, die Folgendes enthält: .. automodule:: some.specific.module :members: Und es wird korrekt generiert.

5Hitze

2Antwort

Hinzufügen einer Klasse zu einer Tabelle in Sphinx?

Ich habe eine Tabelle in rst, und ich möchte eine Klasse hinzufügen, wenn Sie mit Sphinx zu HTML kompilieren. Nach the docs, Hinzufügen einer .. class:: Direktive vor der Tabelle sollte die Klasse der