fix: use absolute URLs for README images (fixes PyPI rendering)#34
Open
BioGeek wants to merge 1 commit into
Open
fix: use absolute URLs for README images (fixes PyPI rendering)#34BioGeek wants to merge 1 commit into
BioGeek wants to merge 1 commit into
Conversation
PyPI does not resolve relative image paths — images must use full URLs to raw.githubusercontent.com. Also fixes the workflow diagram path which pointed to a non-existent images/ directory (the file is actually in docs/source/assets/). Closes #9
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
1 participant
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.
Summary
Fixes #9 — images in the README don't render on PyPI because PyPI cannot resolve relative paths.
Two changes:
instanexus_logo 2.svg): changed from relativedocs/source/assets/...to absoluteraw.githubusercontent.com/...URLinstanexus_panel.png): was pointing to non-existentimages/instanexus_panel.png— fixed to the actual location atdocs/source/assets/instanexus_panel.pngusing an absolute URLAfter merging, a new PyPI release is needed for the fix to appear on the PyPI project page.
Test plan