canonical/sphinx-stack

Underscores in anchor

Open

#390 opened on Jun 3, 2025

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees) (76 forks)auto 404
good first issueimprovementquestion

Repository metrics

Stars
 (34 stars)
PR merge metrics
 (PR metrics pending)

Description

Is there a reason the anchor defined in MyST style guide uses underscores instead of the minus sign (myst_style_guide)? Given that

a) Other anchors in the repo (when defined) use the minus char. b) Sphinx generates the HTML anchor with minus chars, so it's confusing.

Contributor guide

Research direction
Check the MyST style guide for the anchor naming convention and verify how Sphinx generates anchors for headings.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90