Skip to content

Commit

Permalink
small documentation formating
Browse files Browse the repository at this point in the history
  • Loading branch information
12rambau committed Apr 29, 2021
1 parent 5d36685 commit b583ab6
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions docs/source/customize.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,29 @@ Input Options
=============

``spelling_lang='en_US'``

String specifying the language, as understood by PyEnchant and
enchant. Defaults to ``en_US`` for US English.

``tokenizer_lang='en_US'``

String specifying the tokenizer language as understood by PyEnchant
and enchant. Defaults to ``en_US`` for US English.

``spelling_word_list_filename='spelling_wordlist.txt'``

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.

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

Same as above, but with several files of correctly spelled words.

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

A list of glob-style patterns that should be ignored when checking spelling.
They are matched against the source file names relative to the source
directory, using slashes as directory separators on all platforms. See Sphinx's
Expand All @@ -41,10 +50,12 @@ Output Options
==============

``spelling_show_suggestions=False``

Boolean controlling whether suggestions for misspelled words are
printed. Defaults to False.

``spelling_show_whole_line=True``

Boolean controlling whether the contents of the line containing each
misspelled word is printed, for more context about the location of each
word. Defaults to True.
Expand All @@ -65,30 +76,43 @@ Enable or disable the built-in filters to control which words are
returned by the tokenizer to be checked.

``spelling_ignore_pypi_package_names=False``

Boolean controlling whether words that look like package names from
PyPI are treated as spelled properly. When ``True``, the current
list of package names is downloaded at the start of the build and
used to extend the list of known words in the dictionary. Defaults
to ``False``.

``spelling_ignore_wiki_words=True``

Boolean controlling whether words that follow the CamelCase
conventions used for page names in wikis should be treated as
spelled properly. Defaults to ``True``.

``spelling_ignore_acronyms=True``

Boolean controlling treatment of words that appear in all capital
letters, or all capital letters followed by a lower case ``s``. When
``True``, acronyms are assumed to be spelled properly. Defaults to
``True``.

``spelling_ignore_python_builtins=True``

Boolean controlling whether names built in to Python should be
treated as spelled properly. Defaults to ``True``.

``spelling_ignore_importable_modules=True``

Boolean controlling whether words that are names of modules found on
``sys.path`` are treated as spelled properly. Defaults to ``True``.

``spelling_ignore_contributor_names=True``

Boolean controlling whether contributor names taken from the git
history for the repository are considered as spelled correctly.

``spelling_filters=[]``

List of importable filter classes to be added to the tokenizer that
produces words to be checked. For example,
``["enchant.tokenize.MentionFilter"]``. The classes should be
Expand Down

0 comments on commit b583ab6

Please sign in to comment.