getodk / getodk/docs

replace (?) spell checker

Open
#799 4 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
58
Forks
160
Avg merge
5d 11h
Merged PRs (30d)
12

Description

We currently use https://pypi.org/project/sphinxcontrib-spelling/

This plugin relies on [pyenchant](https://github.com/rfk/pyenchant), which is no longer being maintained. Pyenchant cannot readily be installed on Windows.

This doesn't create a problem for Mac/Linux or our CircleCI build, but it creates a error when Windows users `pip install`.

Until we solve that problem, we need to conditionally disable spell check from `conf.py` so that Windows users can at least build locally.

Contributor guide

Open the contributing guide

Research direction

Start in conf.py, where the sphinxcontrib-spelling configuration is defined, and review how pyenchant is loaded during a Windows build. Make spell checking conditional so Windows users can build locally while Mac/Linux and CircleCI retain it. Verify the documentation build on Windows and the existing non-Windows build path.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.