sphinxcontrib-spelling

sphinxcontrib-ortografia é um pacote que contém sphinxcontrb.spelling Sphinx, um corretor ortográfico para baseada em documentação Sphinx & nbsp;. Ele usa PyEnchant para produzir um relatório que mostra as palavras com erros ortográficos.
Instalação :
& Nbsp; 1. Siga as instruções no site PyEnchant para instalar encantar e depois PyEnchant.
& Nbsp; 2. pip instalar sphinxcontrib-ortografia
Configuração :
& Nbsp; 1. Adicionar 'sphinxcontrib.spelling' à lista de extensões em conf.py.
& Nbsp; extensões = ['sphinxcontrib.spelling']
Opções de Configuração
spelling_show_suggestions
& Nbsp; booleana controlar se sugestões para palavras com erros ortográficos são impressos. O padrão é False.
spelling_lang
& Nbsp; string especificando a língua, como entendido por PyEnchant e encantar. Padrões para en_US para US Inglês.
spelling_word_list_filename
& Nbsp; string especificando um arquivo contendo uma lista de palavras que se sabe estarem bem escritas, mas que não aparecem no dicionário do idioma selecionado por spelling_lang. O arquivo deve conter uma palavra por linha. Consulte o Tutoral PyEnchant para mais detalhes.
Executar
Para processar um documento com o verificador ortográfico, utilize sphinx-build e especificar ortografia como o nome do construtor usando a opção -b. O resultado inclui os títulos do documento e todas as palavras com erros ortográficos. Se as sugestões são habilitados, eles são mostrados na mesma linha que o erro de ortografia.
& Nbsp; sphinx-construir saída da fonte de ortografia -b
virtualenvwrapper
& nbsp; Features
& Nbsp; - "Plugin"
& Nbsp; Introdução
& Nbsp; - "plugins"
& Nbsp; Detalhes
& Nbsp; Instalação
& nbsp; Compatível Shells
& Nbsp; - "bitbucket"

O que é novo nesta versão:.

• Avisar, mas de outra forma ignorar tipos de nós desconhecidos

Requisitos :

• Sphinx
• Python