sphinxcontrib-spelling

sphinxcontrib d'orthographe est un paquet qui contient sphinxcontrb.spelling Sphinx, un correcteur d'orthographe pour base-Sphinx documentation & nbsp;. Il utilise PyEnchant pour produire un rapport indiquant les mots mal orthographiés.
Installation :
& Nbsp; 1. Suivez les instructions sur le site de PyEnchant pour installer enchantement puis PyEnchant.
& Nbsp; 2. pip installer sphinxcontrib d'orthographe
Configuration :
& Nbsp; 1. Ajouter 'sphinxcontrib.spelling' à la liste des extensions dans conf.py.
& Nbsp; extensions = ['sphinxcontrib.spelling']
Options de configuration
spelling_show_suggestions
& Nbsp; booléenne contrôler si des suggestions pour les mots mal orthographiés sont imprimés. Par défaut à false.
spelling_lang
& Nbsp; Chaîne spécifiant la langue, telle que comprise par PyEnchant et enchantement. Par défaut, fr_FR pour l'anglais américain.
spelling_word_list_filename
& Nbsp; Chaîne spécifiant un fichier contenant une liste de mots connus pour être correctement orthographié, mais qui ne apparaissent pas dans le dictionnaire de la langue choisie par spelling_lang. Le fichier doit contenir un mot par ligne. Reportez-vous à l'tutoral PyEnchant pour plus de détails.
Running
Pour traiter un document avec le correcteur orthographique, utilisez sphinx-construction et de préciser l'orthographe que le nom du constructeur de l'aide de l'option -b. La sortie comprend les rubriques du document et de tous les mots mal orthographiés. Si suggestions sont activés, ils figurent sur la même ligne que la faute d'orthographe.
& Nbsp; sphinx construire sortie de la source d'orthographe -b
virtualenvwrapper
& nbsp; Caractéristiques
& Nbsp; - "Plugin"
& Nbsp; Présentation
& Nbsp; - "plugins"
& Nbsp; Détails
& Nbsp; Installation
& nbsp; Soutenu coquillages
& Nbsp; - "bitbucket"

Ce qui est nouveau dans cette version:.

• avertir mais sinon ignorer types de nœuds inconnus

Exigences :

• Sphinx
• Python