Repository navigation
fix: absolute image URLs in the README for the PyPI page - #8
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Type
Related issue
None
What changed
PyPI renders the README as-is, so the repo-relative image paths (
docs/brand/...) 404 on the project page there. Every image in the README now uses its absoluteraw.githubusercontent.comURL, which resolves on GitHub and PyPI alike; the files themselves are unchanged and already onmain.Two small fixes ride along: browser tab titles on the docs site use a middot (
page · clvkit) instead of the em dash Sphinx hardcodes, and the pytest line in CONTRIBUTING no longer quotes a test count that goes stale with every added test.How it was tested
uv run pytest— 254 passed, 1 skipped.uv run ruff checkanduv run ruff format --checkclean.uv buildproduces the 0.1.0 sdist and wheel. The raw URLs were checked againstmain, where every referenced file resolves.Checks
uv run pytestuv run ruff checkuv run ruff format --checkuv run pytest --nbmake examples/)