[doc] support building with spell check

This commit is contained in:
Quantum
2021-09-01 19:14:58 -04:00
committed by Geoffrey McRae
parent 1b58f2592c
commit 753b44e34f
3 changed files with 96 additions and 0 deletions

View File

@@ -36,6 +36,22 @@ rst_prolog = """
extensions = [
]
try:
from sphinxcontrib import spelling
except ImportError:
pass
else:
del spelling
extensions += ['sphinxcontrib.spelling']
import sys, os
sys.path.append(os.path.dirname(__file__))
spelling_filters = [
'lgspell.OptionFilter', 'lgspell.PackageFilter', 'lgspell.PathFilter',
'lgspell.CryptoAddressFilter'
]
spelling_word_list_filename = [os.path.join(os.path.dirname(__file__), 'words.txt')]
# Add any paths that contain templates here, relative to this directory.
# templates_path = ['_templates']