docs: Add spell checking prerequisites for building documentation #2222
+11
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JohananOppongAmoateng
force-pushed
the
docs/add-prerequisites-enchant-install
branch
from
c3650e3 to
64adeeb
Compare
docs/contributing.rst
Outdated
Comment on lines
228
to
243
| Additionally, to build the documentation with proper spell checking, | ||
| you need to install: | ||
|
|
||
| - **Enchant Library** - This is required by the sphinxcontrib-spelling | ||
| extension via the pyenchant package. Installation instructions vary by | ||
| platform: | ||
|
|
||
| - **Windows**: The binary wheel includes a pre-compiled Enchant library. | ||
| - **macOS**: ``brew install enchant`` | ||
| - **Linux**: Use your distribution's package manager | ||
| (e.g., ``apt install enchant``) | ||
|
|
||
| - **FreeBSD**: ``pkg install enchant-2`` | ||
|
|
||
| - **FreeBSD**: ``pkg install enchant-2`` | ||
|
|
There was a problem hiding this comment.
I think we should try to be more concise here. We're pretty far removed from enchant, so I think forwarding people to pyenchant's documentation is sufficient rather than trying to explain all the different methods. Does that seem reasonable to you?
There was a problem hiding this comment.
Yes i understand thats true
JohananOppongAmoateng
force-pushed
the
docs/add-prerequisites-enchant-install
branch
from
db03887 to
13fc5c0
Compare
|
Thank you @okotdaniel for identifying this issue! |
You are welcome. |
JohananOppongAmoateng
deleted the
docs/add-prerequisites-enchant-install
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This pull request updates the documentation to clarify prerequisites for building documentation with spell checking. The main change is the addition of instructions for installing the Enchant library, which is required by the
sphinxcontrib-spellingextension.Documentation improvements:
docs/contributing.rstdetailing how to install the Enchant library for different platforms (Windows, macOS, Linux, FreeBSD), including a link to the official installation guide.Fixes #2221
Checklist:
docs/changes.rst.