search

larryhastings / appeal

Command-line parsing library for Python 3.
Other
122 stars 7 forks source link

Use absolute image to fix PyPI display #8

Closed hugovk closed 1 year ago

hugovk commented 1 year ago

The README images don't show on https://pypi.org/project/appeal/ because it can't resolve the relative links:

image

Instead, use GitHub's absolute raw links.

This is what we do for https://github.com/python-pillow/Pillow + https://pypi.org/project/Pillow/

larryhastings commented 1 year ago

I don't know how to preview this and see it working, so I'm gonna merge and hope for the best. Assuming it works... thanks, Hugo!

hugovk commented 1 year ago

We can render the HTML output in the same way PyPI does using the code snippet at https://github.com/pypa/readme_renderer/issues/196#issuecomment-787642266

python render.py README.md -o /tmp/index.html  # To another path so cannot use relative links

Creates:

index.html.zip

larryhastings commented 1 year ago

I just published the first version since accepting your PR, and unsurprisingly it works fine. Thanks again!