File tree Expand file tree Collapse file tree 1 file changed +19
-0
lines changed Expand file tree Collapse file tree 1 file changed +19
-0
lines changed Original file line number Diff line number Diff line change @@ -225,6 +225,25 @@ Prerequisites
225225Before building the documentation, ensure that all dependencies are installed
226226as described in :ref: `the setup instructions <code >`.
227227
228+ Additionally, to build the documentation with proper spell checking,
229+ you need to install:
230+
231+ - **Enchant Library ** - This is required by the sphinxcontrib-spelling
232+ extension via the pyenchant package. Installation instructions vary by
233+ platform:
234+
235+ - **Windows **: The binary wheel includes a pre-compiled Enchant library.
236+ - **macOS **: ``brew install enchant ``
237+ - **Linux **: Use your distribution's package manager
238+ (e.g., ``apt install enchant ``)
239+
240+ - **FreeBSD **: ``pkg install enchant-2 ``
241+
242+ - **FreeBSD **: ``pkg install enchant-2 ``
243+
244+ For detailed installation instructions, see the `pyenchant installation documentation
245+ <https://pyenchant.github.io/pyenchant/install.html#installing-the-enchant-c-library> `_.
246+
228247
229248
230249Using Tox (Cross-Platform)
You can’t perform that action at this time.
0 commit comments