Skip to content

Document how to display README images on PyPI - #2192

Merged
rgommers merged 3 commits into
pypa:mainfrom
rgommers:image-in-readme-on-pypi
Nov 17, 2026
Merged

rgommers merged 3 commits into
pypa:mainfrom
rgommers:image-in-readme-on-pypi

Conversation

@rgommers

@rgommers rgommers commented Nov 13, 2026 •

Copy link
Copy Markdown
Contributor

Add md and .rst examples using public image URLs. Note that relative paths to images bundled in distribution archives do not work for PyPI descriptions, as well as the limitations on embedded media.

Closes gh-1110


📚 Documentation preview 📚: https://python-packaging-user-guide--2192.org.readthedocs.build/en/2192/

Add Markdown and reStructuredText examples using public image URLs.
Note that relative paths to images bundled in distribution archives
do not work for PyPI descriptions, as well as the limitations on
embedded media.

Closes pypagh-1110
@rgommers
rgommers added this pull request to the merge queue Nov 17, 2026
Merged via the queue into pypa:main with commit 217512f Nov 17, 2026
7 checks passed
@rgommers
rgommers deleted the image-in-readme-on-pypi branch November 17, 2026 18:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component: guides type: enhancement A self-contained enhancement or new feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Guide how to images for projects; screenshots; logos; guides; gifs; videos

3 participants