Skip to content

docs: Add spell checking prerequisites for building documentation #2222

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tim-schilling merged 3 commits into from
Oct 13, 2025
Merged

docs: Add spell checking prerequisites for building documentation #2222

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
64adeeb
docs: Add spell checking prerequisites for building documentation
JohananOppongAmoateng Oct 10, 2025
13fc5c0
docs: simplify Enchant installation note
JohananOppongAmoateng Oct 12, 2025
1bc9f1c
docs: add sphinxcontrib and pyenchant to spelling wordlist
JohananOppongAmoateng Oct 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,25 @@ Prerequisites
Before building the documentation, ensure that all dependencies are installed
as described in :ref:`the setup instructions <code>`.

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``

Copy link
Member

@tim-schilling tim-schilling Oct 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

Copy link
Contributor Author

@JohananOppongAmoateng JohananOppongAmoateng Oct 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes i understand thats true

For detailed installation instructions, see the `pyenchant installation documentation
<https://pyenchant.github.io/pyenchant/install.html#installing-the-enchant-c-library>`_.



Using Tox (Cross-Platform)
Expand Down
Loading