Skip to content

Commit

Permalink
update spelling check configuration information
Browse files Browse the repository at this point in the history
Clarify where the spelling check configuration is, but don't call
out that you can change the language to en_US anymore.

Signed-off-by: Ruth Fuchss <[email protected]>
  • Loading branch information
ru-fu committed Nov 14, 2023
1 parent 1393e0b commit 35a5394
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions readme.rst
Original file line number Diff line number Diff line change
Expand Up @@ -173,8 +173,8 @@ For example, you might want to add links to announcements, tutorials, getting st
Configure the spelling check
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

If your documentation uses US English instead of UK English, change this in the
``.sphinx/spellingcheck.yaml`` file.
The spelling check uses ``aspell``.
Its configuration is located in the ``.sphinx/spellingcheck.yaml`` file.

To add exceptions for words flagged by the spelling check, edit the ``.custom_wordlist.txt`` file.
You shouldn't edit ``.wordlist.txt``, because this file is maintained and updated centrally and contains words that apply across all projects.
Expand Down

0 comments on commit 35a5394

Please sign in to comment.