Die WebSupport-Klasse

class sphinxcontrib.websupport.WebSupport

Die Haupt-API-Klasse für das Web-Support-Paket. Alle Interaktionen mit dem Web-Support-Paket sollten über diese Klasse erfolgen.

Die Klasse nimmt die folgenden Schlüsselwortargumente entgegen

srcdir

Das Verzeichnis, das reStructuredText-Quelldateien enthält.

builddir

Das Verzeichnis, in dem Build-Daten und statische Dateien abgelegt werden sollen. Dies sollte beim Erstellen eines WebSupport-Objekts verwendet werden, das zum Erstellen von Daten verwendet wird.

datadir

Das Verzeichnis, in dem sich die Web-Support-Daten befinden. Dies sollte beim Erstellen eines WebSupport-Objekts verwendet werden, das zum Abrufen von Daten verwendet wird.

search

Dies kann entweder einen String (z. B. 'xapian') enthalten, der auf einen zu verwendenden integrierten Suchadapter verweist, oder eine Instanz einer Unterklasse von BaseSearch.

storage

Dies kann entweder einen String, der eine Datenbank-URI darstellt, oder eine Instanz einer Unterklasse von StorageBackend enthalten. Wenn dies nicht angegeben wird, wird eine neue SQLite-Datenbank erstellt.

moderation_callback

Ein aufrufbares Objekt, das aufgerufen werden muss, wenn ein neuer Kommentar hinzugefügt wird, der nicht angezeigt wird. Es muss ein Argument akzeptieren: ein Dictionary, das den hinzugefügten Kommentar darstellt.

staticdir

Wenn die statischen Dateien an einem anderen Ort erstellt werden sollen und nicht in '/static', sollte dies ein String mit dem Namen dieses Ortes sein (z. B. builddir + '/static_files').

Hinweis

Wenn Sie staticdir angeben, möchten Sie wahrscheinlich staticroot entsprechend anpassen.

staticroot

Wenn die statischen Dateien nicht von '/static' bereitgestellt werden, sollte dies ein String mit dem Namen dieses Ortes sein (z. B. '/static_files').

docroot

Wenn die Dokumentation nicht vom Basis-Pfad einer URL bereitgestellt wird, sollte dies ein String sein, der diesen Pfad angibt (z. B. 'docs').

Geändert in Version 1.6: Die WebSupport-Klasse wurde von sphinx.websupport nach sphinxcontrib.websupport verschoben. Bitte fügen Sie das Paket sphinxcontrib-websupport zu Ihren Abhängigkeiten hinzu und verwenden Sie die verschobene Klasse stattdessen.

Methoden