Skip to content

Commit c3650e3

Browse files
docs: Add spell checking prerequisites for building documentation
1 parent e2e7242 commit c3650e3

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/contributing.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,19 @@ Prerequisites
225225
Before building the documentation, ensure that all dependencies are installed
226226
as 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

230243
Using Tox (Cross-Platform)

0 commit comments

Comments
 (0)