Skip to content

Commit 85885d7

Browse files
docs: Add spell checking prerequisites for building documentation (#2222)
* docs: Add spell checking prerequisites for building documentation * docs: add sphinxcontrib and pyenchant to spelling wordlist
1 parent e2e7242 commit 85885d7

File tree

2 files changed

+11
-0
lines changed

2 files changed

+11
-0
lines changed

docs/contributing.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,15 @@ 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. For detailed installation
233+
instructions, see the
234+
`pyenchant installation documentation <https://pyenchant.github.io/pyenchant/install.html#installing-the-enchant-c-library>`_.
235+
236+
228237

229238

230239
Using Tox (Cross-Platform)

docs/spelling_wordlist.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,7 @@ pre
4848
profiler
4949
psycopg
5050
py
51+
pyenchant
5152
pyflame
5253
pylibmc
5354
pytest
@@ -58,6 +59,7 @@ reinitializing
5859
resizing
5960
runserver
6061
spellchecking
62+
sphinxcontrib
6163
spooler
6264
stacktrace
6365
stacktraces

0 commit comments

Comments
 (0)