sphinx-doc / sphinx-doc/sphinx

error messages in dark red are hard to read

Open
#5,989 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

api:cmdline type:enhancement
Dominant language
Python
Stars
8k
Forks
2.6k
PR merge metrics
No merged PRs in 30d

Description

Sphinx displays error messages with a dark red font that some with poor eyesight have trouble reading. It would be great to have a configuration option that would change this to another color (e.g., bright red) to provide higher contrast.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue names no files or tests. Start by locating the Sphinx code and documentation that define error-message styling and configuration options; then verify that the new color setting improves contrast and is covered by appropriate documentation or tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
accessibility, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.