diff --git a/odkx-src/docs-developer-guide.rst b/odkx-src/docs-developer-guide.rst index cf5d8cc2..4d268c52 100644 --- a/odkx-src/docs-developer-guide.rst +++ b/odkx-src/docs-developer-guide.rst @@ -341,6 +341,18 @@ specify the check name in the check list in the function :py:func:`exclude_checks` in the file :file:`style-test.py`. +Excluding Spelling checks +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +To exclude a word from spelling check,specify the word under the title spelling on the top of the document. +Example: + + .. code-block:: console + + .. spelling:: + phpLDAPadmin + readonly + letsencrypt @@ -355,4 +367,4 @@ in the file :file:`style-test.py`. please update the :file:`requirements.txt` file with :command:`pip freeze > requirements.txt`. Pull requests which change :file:`requirements.txt` - should include a note about why the new package is needed. \ No newline at end of file + should include a note about why the new package is needed.