astropy / astropy/astropy-mentoring

Add spell check to Sphinx config

Open
#2 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
2
Forks
4
PR merge metrics
No merged PRs in 30d

Description

We should add some kind of spell check to the Sphinx config since this is going to be a text-heavy repo.

Contributor guide

No contributing guide indexed for this repository

Research direction

Locate the Sphinx configuration and documentation build entry point, then review how extensions or checks are currently configured. Decide what spell-checking approach fits the text-heavy repository and verify that the documentation build reports spelling errors when the work is complete.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.