sphinxcontrib-spelling

sphinxcontrib-Rechtschreibung ist eine Sphinx-Paket, das sphinxcontrb.spelling, eine Rechtschreibprüfung für Sphinx-basierte Dokumentation & nbsp enthält;. Es verwendet PyEnchant um einen Bericht, der falsch geschriebene Wörter zu produzieren.
Installation :
& Nbsp; 1. Folgen Sie den Anweisungen auf der Website, um PyEnchant verzaubern installieren und dann PyEnchant.
& Nbsp; 2. pip sphinxcontrib-Schreibung installieren
Konfiguration :
& Nbsp; 1. Add 'sphinxcontrib.spelling' auf der Liste Erweiterungen in conf.py.
& Nbsp; Erweiterungen = ['sphinxcontrib.spelling']
Konfigurations-Optionen
spelling_show_suggestions
& Nbsp; Boolean gesteuert wird, ob Vorschläge für falsch geschriebene Wörter werden gedruckt. Der Standardwert ist False.
spelling_lang
& Nbsp; String, der die Sprache, wie von PyEnchant und verzaubern zu verstehen. Der Standardwert ist en_US für US-Englisch.
spelling_word_list_filename
& Nbsp; String, der eine Datei mit einer Liste von Wörtern bekannt, richtig geschrieben werden, die jedoch nicht in der Sprache Wörterbuch spelling_lang ausgewählt angezeigt. Die Datei sollte ein Wort pro Zeile enthalten. Siehe den PyEnchant tutoral für Details.
Ausführen
Um ein Dokument mit der Rechtschreibprüfung zu bearbeiten, verwenden sphinx-build, und geben Sie die Rechtschreibung als Erbauer Namen mit der Option -b. Die Ausgabe enthält die Überschriften aus dem Dokument und alle falsch geschriebene Wörter. Wenn Vorschläge aktiviert sind, werden sie auf der gleichen Linie wie die Rechtschreibfehler angezeigt.
& Nbsp; sphinx bauen -b Rechtschreibung Quellenausgang
virtualenvwrapper
& Nbsp; Merkmale
& Nbsp; - "Plugin"
& Nbsp; Einführung
& Nbsp; - "Plugins"
& Nbsp; Einzelheiten
& Nbsp; Installations
& Nbsp; Unterstützte Shells
& Nbsp; - "bitbucket"

Was ist neu in dieser Pressemitteilung:.

• Warnen, aber unbekannten Knotentypen sonst ignorieren

Anforderungen :

• Sphinx
• Python