diff --git a/docs/contributing.rst b/docs/contributing.rst index 6377e59ea..94b2b8b18 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -225,6 +225,15 @@ Prerequisites Before building the documentation, ensure that all dependencies are installed as described in :ref:`the setup instructions `. +Additionally, to build the documentation with proper spell checking, +you need to install: + +- **Enchant Library** - This is required by the sphinxcontrib-spelling + extension via the pyenchant package. For detailed installation + instructions, see the + `pyenchant installation documentation `_. + + Using Tox (Cross-Platform) diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt index 472ad15bd..9396fea41 100644 --- a/docs/spelling_wordlist.txt +++ b/docs/spelling_wordlist.txt @@ -48,6 +48,7 @@ pre profiler psycopg py +pyenchant pyflame pylibmc pytest @@ -58,6 +59,7 @@ reinitializing resizing runserver spellchecking +sphinxcontrib spooler stacktrace stacktraces