Skip to content

Commit

Permalink
Documetnation updated as per review
Browse files Browse the repository at this point in the history
  • Loading branch information
grhm authored and dhellmann committed May 30, 2022
1 parent 1e79ccb commit 62a3247
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/source/customize.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,10 @@ Input Options
String specifying a file containing a list of words known to be
spelled correctly but that do not appear in the language dictionary
selected by ``spelling_lang``. The file should contain one word per
line. Refer to the `PyEnchant tutorial`_ for details. Use a list to add
multiple files.
line. Refer to the `PyEnchant tutorial`_ for details. To add multiple
files use a list, or a comma separated string. This is useful when
calling sphinx with ``-D spelling_word_list_filename=...`` which will
not accept a list and will only accept a string parameter.

``spelling_word_list_filename=['spelling_wordlist.txt','another_list.txt']``

Expand All @@ -37,9 +39,7 @@ Input Options
``spelling_word_list_filename='spelling_wordlist.txt,another_list.txt'``

Same as above, but with several files of correctly spelled words, and
passing the setting as a single string. This is useful when calling
sphinx with ``-D spelling_word_list_filename=...`` which will only
accept a string parameter.
passing the setting as a single string.

``spelling_exclude_patterns=['ignored_*']``

Expand Down

0 comments on commit 62a3247

Please sign in to comment.