diff --git a/docs/conf.py b/docs/conf.py index 96ad6bb..48f361e 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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. @@ -195,3 +196,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 diff --git a/docs/spelling/fixes.txt b/docs/spelling/fixes.txt new file mode 100644 index 0000000..2c0351f --- /dev/null +++ b/docs/spelling/fixes.txt @@ -0,0 +1,3 @@ +premade +todo +emoji diff --git a/docs/spelling/names.txt b/docs/spelling/names.txt new file mode 100644 index 0000000..6ec43dc --- /dev/null +++ b/docs/spelling/names.txt @@ -0,0 +1,3 @@ +Facebook +GraphQL +GitHub diff --git a/docs/spelling/technical.txt b/docs/spelling/technical.txt new file mode 100644 index 0000000..2595ac9 --- /dev/null +++ b/docs/spelling/technical.txt @@ -0,0 +1,14 @@ +iterables +timestamp +metadata +spam +spammy +admin +admins +unsend +unsends +unmute +spritemap +online +inbox +subclassing diff --git a/pyproject.toml b/pyproject.toml index 0621021..136268d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -56,6 +56,7 @@ test = [ ] docs = [ "sphinx~=2.0", + "sphinxcontrib-spelling~=4.0" ] lint = [ "black",