karaolidis/fbchat
Archived
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #455 from carpedm20/add-spell-check

Browse Source 
Add spell checking.

Use sphinxcontrib-spelling to fix documentation and docstring spelling errors.
This commit is contained in:
Mads Marquart
2019-07-25 18:51:53 +02:00
committed by GitHub
parent 441f53e382 83c45dcf40
commit 0389b838bc
28 changed files with 148 additions and 113 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/conf.py
View File

@@ -42,6 +42,7 @@ extensions = [
"sphinx.ext.todo",
"sphinx.ext.viewcode",
"sphinx.ext.napoleon",
"sphinxcontrib.spelling",
]
# Add any paths that contain templates here, relative to this directory.
@@ -193,3 +194,15 @@ napoleon_numpy_docstring = False
# napoleon_use_admonition_for_examples = False
# napoleon_use_admonition_for_notes = False
# napoleon_use_admonition_for_references = False
# -- Options for spelling extension ----------------------------------------------
spelling_word_list_filename = [
"spelling/names.txt",
"spelling/technical.txt",
"spelling/fixes.txt",
]
spelling_ignore_wiki_words = False
# spelling_ignore_acronyms = False
spelling_ignore_python_builtins = False
spelling_ignore_importable_modules = False