File tree Expand file tree Collapse file tree 1 file changed +13
-0
lines changed Expand file tree Collapse file tree 1 file changed +13
-0
lines changed Original file line number Diff line number Diff line change @@ -225,6 +225,19 @@ 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, you need to install:
229+
230+ - **Enchant Library ** - This is required by the sphinxcontrib-spelling extension via
231+ the pyenchant package. Installation instructions vary by platform:
232+
233+ - **Windows **: The binary wheel includes a pre-compiled Enchant library.
234+ - **macOS **: ``brew install enchant ``
235+ - **Linux **: Use your distribution's package manager (e.g., ``apt install enchant ``)
236+ - **FreeBSD **: ``pkg install enchant-2 ``
237+
238+ For detailed installation instructions, see the `pyenchant installation documentation
239+ <https://pyenchant.github.io/pyenchant/install.html#installing-the-enchant-c-library> `_.
240+
228241
229242
230243Using Tox (Cross-Platform)
You can’t perform that action at this time.
0 commit comments