-
Notifications
You must be signed in to change notification settings - Fork 3.4k
-
Notifications
You must be signed in to change notification settings - Fork 3.4k
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
Possible regression: badge
UI pattern in ReStructuredText now fails to render inline images
#1801
Comments
I think what may have happened (and this is partially a guess) is that GitHub is now converting reStructuredText to HTML 5 rather than HTML 4. For whatever reason, Docutils' HTML 4 converter renders a sequence of |
github/markup#1801 (comment) https://docutils.sourceforge.io/docs/ref/rst/directives.html#image Signed-off-by: Stephen Whitlock <stephen@jshwisolutions.com>
github/markup#1801 (comment) https://docutils.sourceforge.io/docs/ref/rst/directives.html#image Signed-off-by: Stephen Whitlock <stephen@jshwisolutions.com>
github/markup#1801 (comment) https://docutils.sourceforge.io/docs/ref/rst/directives.html#image Signed-off-by: Stephen Whitlock <stephen@jshwisolutions.com>
github/markup#1801 (comment) https://docutils.sourceforge.io/docs/ref/rst/directives.html#image Signed-off-by: Stephen Whitlock <stephen@jshwisolutions.com>
This was working nicely before, this is still working nicely in every Sphinx build documentation and is still working nicely in all pypi readme that I published since RST is broken on GitHub. Can you make the proper adjusmtent or use a more modern rst builder so the behaviour of github readme continues to be aligned with the tools used by the Python community ? |
apply the workaround from github/markup#1801
Work around github/markup#1801. Signed-off-by: Omar Sandoval <osandov@osandov.com>
Stale issue message |
It is a common pattern in the Python community to use something similar to the following snippet (in ReStructuredText) to add "badges" as a UI block at the top of the README of repositories:
Previously, that would render as a horizontal bar:
But now each image is occupying a new line:
Please note that this was a pattern that historically emerged in the community, so it is wide spread.
Therefore this change affects a lot of repositories, and in my opinion represents a regression.
Examples of repositories affected by this change:
https://github.com/python/cpython/tree/v3.13.0a6
https://github.com/pypa/setuptools/tree/v69.5.1
https://github.com/pyca/cryptography/tree/42.0.5
https://github.com/pytest-dev/pytest/tree/v7.4.3
https://github.com/benjaminp/six/tree/1.16.0
https://github.com/scipy/scipy/tree/v1.13.0
https://github.com/pyscaffold/pyscaffold/tree/v4.5
https://github.com/pyca/pynacl/tree/v0.3.0
https://github.com/jpadilla/pyjwt/tree/2.8.0
https://github.com/jaraco/zipp/tree/v3.18.1
https://github.com/python/importlib_metadata/tree/v7.1.0
https://github.com/python/importlib_resources/tree/v6.4.0
https://github.com/pypa/readme_renderer/tree/43.0
and many more ...
The text was updated successfully, but these errors were encountered: