source/django
1
0
Fork 0
mirror of https://github.com/django/django.git synced 2026-02-09 02:49:25 +08:00
Code Issues Packages Projects Releases Wiki Activity

Made explicit that aspell is a requirement to run spell checks on docs.

Browse Source
This commit is contained in:
Natalia
2026-01-29 10:04:47 -03:00
committed by nessita
parent ba96379011
commit 117ff1d37d
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/internals/contributing/writing-documentation.txt
View File

@@ -178,8 +178,9 @@ Spelling check
~~~~~~~~~~~~~~
Before you commit your docs, it's a good idea to run the spelling checker.
You'll need to install :pypi:`sphinxcontrib-spelling` first. Then from the
``docs`` directory, run:
You'll need to install :pypi:`sphinxcontrib-spelling` first. The spell checker
also requires a system-level spell checking backend such as `Aspell
<http://aspell.net/>`__. Then from the ``docs`` directory, run:
.. console::