p15693087
/
django
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Removed redundant pyenchant dependency in spelling check docs.

This commit is contained in:
David Smith 2020-06-01 06:07:56 +01:00 committed by GitHub
parent 8dabdd2cc5
commit 7514852767
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -496,16 +496,10 @@ Spelling check
============== ==============
Before you commit your docs, it's a good idea to run the spelling checker. Before you commit your docs, it's a good idea to run the spelling checker.
You'll need to install a couple packages first: You'll need to install `sphinxcontrib-spelling
<https://pypi.org/project/sphinxcontrib-spelling/>`_ first. Then from the
* `pyenchant <https://pypi.org/project/pyenchant/>`_ (which requires ``docs`` directory, run ``make spelling``. Wrong words (if any) along with the
`enchant <https://www.abisource.com/projects/enchant/>`_) file and line number where they occur will be saved to
* `sphinxcontrib-spelling
<https://pypi.org/project/sphinxcontrib-spelling/>`_
Then from the ``docs`` directory, run ``make spelling``. Wrong words (if any)
along with the file and line number where they occur will be saved to
``_build/spelling/output.txt``. ``_build/spelling/output.txt``.
If you encounter false-positives (error output that actually is correct), do If you encounter false-positives (error output that actually is correct), do