Skip to content

Use pypa readme renderer to figure out how to handle images #830

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
kratsg opened this issue Apr 21, 2020 · 5 comments
Closed

Use pypa readme renderer to figure out how to handle images #830

kratsg opened this issue Apr 21, 2020 · 5 comments
Labels
docs Documentation related help wanted Extra attention is needed / contributions welcome question Further information is requested

Comments

@kratsg
Copy link
Contributor

kratsg commented Apr 21, 2020

Question

https://github.com/pypa/readme_renderer seems to be what is used to generate the html page for the README. It seems this should have been fixed according to linked issues/PRs below. But we definitely have issues with the image size of the stackoverflow logo at the bottom here: https://test.pypi.org/project/pyhf/0.4.2.dev20/ . It seems the width attribute is still being stripped from the rST.

Relevant Issues and Pull Requests

@kratsg kratsg added help wanted Extra attention is needed / contributions welcome question Further information is requested docs Documentation related labels Apr 21, 2020
@matthewfeickert
Copy link
Member

matthewfeickert commented Apr 21, 2020

@dstufft @theacodes @di if you have thoughts/advice here, we would be interested in them. If you would prefer, we can also open up an Issue on readme_renderer.

@di
Copy link

di commented Apr 21, 2020

There was a regression (mentioned here) that should be fixed by pypa/readme_renderer#164.

@matthewfeickert
Copy link
Member

There was a regression (mentioned here) that should be fixed by pypa/readme_renderer#164.

Many thanks for the super speedy diagnosis and reply!

@matthewfeickert
Copy link
Member

matthewfeickert commented Apr 23, 2020

Given @di's super awesome responsiveness the fix for this (pypa/readme_renderer#164) has already gone into a new major release v26.0 in pypa/readme_renderer#165! As explained in his comment

old descriptions should get eventually re-rendered, so you shouldn't have to make a new release to see the update (although new releases will definitely get it right away).

So there should be no further action to take on this. 🚀

I won't formally close this Issue until we notice that things render properly on TestPyPI (with prep for patch release v0.4.2 we'll be checking there frequently anyway), but this Issue is resolved now. 👍

@matthewfeickert
Copy link
Member

Closing this now as TestPyPI is rendering fine. 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related help wanted Extra attention is needed / contributions welcome question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants