Skip to content

Commit 64adeeb

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

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

docs/contributing.rst

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,25 @@ 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,
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

230249
Using Tox (Cross-Platform)

0 commit comments

Comments
 (0)