diff options
| author | Natalia <124304+nessita@users.noreply.github.com> | 2026-01-29 10:04:47 -0300 |
|---|---|---|
| committer | nessita <124304+nessita@users.noreply.github.com> | 2026-01-29 11:20:11 -0300 |
| commit | 117ff1d37d63cdfa0982eba6b636bf8f59d99a3c (patch) | |
| tree | b8686618e1e88764c2e9e4958f0daa6c0be64892 | |
| parent | ba9637901113deb9ae808b2ba1798c18dc85a915 (diff) | |
Made explicit that aspell is a requirement to run spell checks on docs.
| -rw-r--r-- | docs/internals/contributing/writing-documentation.txt | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/docs/internals/contributing/writing-documentation.txt b/docs/internals/contributing/writing-documentation.txt index 09a790b4a3..90e9533db8 100644 --- a/docs/internals/contributing/writing-documentation.txt +++ b/docs/internals/contributing/writing-documentation.txt @@ -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:: |