[Docs] Add spellchecking with pyenchant

- Use sphinxcontrib.spelling with custom wordlist.
- Skip the checking of the modules documents as they raise
false-positives.
- Add a setup.py spellcheck_docs command.
- Fix spelling and other issues.
- Add a doc favicon.
This commit is contained in:
Calum Lind
2019-06-15 19:44:33 +01:00
parent 5b315e90c5
commit 8b62e50eb8
28 changed files with 191 additions and 134 deletions

View File

@ -152,7 +152,8 @@ sitepackages = False
deps = {[basedocs]deps}
commands =
python setup.py clean_docs
sphinx-build -v -j auto -E -T -b html -d docs/build/doctrees docs/source docs/build/html
sphinx-build -v -j auto -E -b html -d docs/build/doctrees docs/source docs/build/html
sphinx-build -v -j auto -b spelling -d docs/build/doctrees docs/source docs/build/spelling
[testenv:docscoverage]
sitepackages = False