Skip to content

Readme badge underlines fix - #14780

Open
Darlokt wants to merge 3 commits into
sphinx-doc:masterfrom
Darlokt:readme-badge-underlines
Open

Darlokt wants to merge 3 commits into
sphinx-doc:masterfrom
Darlokt:readme-badge-underlines

Conversation

@Darlokt

@Darlokt Darlokt commented Oct 24, 2026

Copy link
Copy Markdown
Contributor

Purpose

Hej,
this is the fix for the issue with the GitHub README I reported in #14779.

The underlines come from line breaks inside the badge links.
Each standalone .. image:: directive is written as its own link with a line break before </a>.
This fix groups the badges into one line using substitutions.
GitHub's reST renderer also adds a line break after images whose URL ends in .svg, so the badge URLs no longer end in .svg.

The documentation badge fails because Read the Docs rate-limits GitHub's image proxy.
This fix serves it from shields.io instead, like the PyPI and license badges already are.

With the fix, all four badges render without underlines on the branch's README.

References

AI Disclosure

None to declare.

GitHub's image proxy (camo) currently gets HTTP 429 from Read the Docs when fetching the badge, so the README shows a broken image.
shields.io fetches the Read the Docs status on its own servers and caches it, like the PyPI and license badges already do.

@timhoffm timhoffm left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks!

@jdillard
jdillard self-requested a review October 26, 2026 00:50

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

3 participants