sphinx.ext.duration – Messen von Sphinx-Verarbeitungsdauern

Hinzugefügt in Version 2.4.

Diese Erweiterung misst die Dauern der Sphinx-Verarbeitung beim Lesen von Dokumenten und ist nützlich, um zu überprüfen, welche Dokumente langsam erstellt werden. Dauern werden am Ende des Builds auf der Konsole ausgegeben und standardmäßig in einer JSON-Datei im Ausgabeordner gespeichert.

Aktivieren Sie diese Erweiterung, indem Sie 'sphinx.ext.duration' zur Liste extensions in Ihrer conf.py hinzufügen.

extensions = [
    ...
    'sphinx.ext.duration',
]

Konfiguration

duration_print_total
Typ:
bool
Standard:
True

Zeigt die gesamte Lesedauer in der Build-Zusammenfassung an, z. B.

====================== total reading duration ==========================
Total time reading 31 files: 0m 3.142s

Hinzugefügt in Version 9.0.

duration_print_slowest
Typ:
bool
Standard:
True

Zeigt die langsamsten Dauern in der Build-Zusammenfassung an. Die Dauern werden von der langsamsten zur schnellsten sortiert. Dies gibt bis zu duration_n_slowest Dauern aus, z. B.

====================== slowest 5 reading durations =======================
0.012s spam
0.011s ham
0.011s eggs
0.006s lobster
0.005s beans

Hinzugefügt in Version 9.0.

duration_n_slowest
Typ:
int
Standard:
5

Maximale Anzahl von langsamsten Dauern, die in der Build-Zusammenfassung angezeigt werden, wenn duration_print_slowest aktiviert ist. Standardmäßig werden nur die 5 langsamsten Dauern angezeigt. Setzen Sie dies auf 0, um alle Dauern anzuzeigen.

Hinzugefügt in Version 9.0.

duration_write_json
Typ:
str | None
Standard:
'sphinx-reading-durations.json'

Schreibt alle Lesedauern in eine JSON-Datei im Ausgabeordner. Der Dateiinhalt ist eine Zuordnung von Dokumentennamen zu Lesedauern, wobei Dokumentennamen Strings und Dauern Floats in Sekunden sind. Setzen Sie diesen Wert auf eine leere Zeichenkette oder None, um das Schreiben der Datei zu deaktivieren, oder setzen Sie ihn auf einen relativen Pfad, um ihn anzupassen.

Dies kann für Tests nützlich sein und um eine Grenze für Lesezeiten festzulegen.

Hinzugefügt in Version 9.0.

duration_limit
Typ:
float | int | None
Standard:
None

Setzt ein Dauer-Limit (in Sekunden) für das Lesen eines Dokuments. Wenn eine Dauer diesen Wert überschreitet, wird eine Warnung ausgegeben.

Hinzugefügt in Version 9.0.