Image height is ignored in RST #295

vitaut · 2014-04-25T16:03:10Z

The height option is ignored in RST image directives. For example:

.. image:: https://ci.appveyor.com/api/projects/status/qk0bhyhqp1ekpat8
  :height: 18px

is converted to the following HTML:

<img alt="https://travis-ci.org/cppformat/cppformat.png?branch=master"
src="https://camo.githubusercontent.com/b80618c2de7685ea4a249567a9226130bb238649/68747470733a2f2f7472617669732d63692e6f72672f637070666f726d61742f637070666f726d61742e706e673f6272616e63683d6d6173746572"
data-canonical-src="https://travis-ci.org/cppformat/cppformat.png?branch=master"
style="max-width:100%;">

(note missing height), while rst2html gives the following output:

<img alt="https://ci.appveyor.com/api/projects/status/qk0bhyhqp1ekpat8"
src="https://ci.appveyor.com/api/projects/status/qk0bhyhqp1ekpat8"
style="height: 18px;" />

The text was updated successfully, but these errors were encountered:

bkeepers · 2014-05-27T14:11:00Z

Image sizes are currently sanitized out. I would love to figure out a solution to the retina issue, per your example. Besides retina images, I haven't seen many compelling use cases for general image sizing.

ssbarnea · 2015-04-01T12:37:29Z

This is a clear bug and it has nothign to do with the retina. Here is a simple use case for using images of different resolution: you have credits or sponsors for your project and you want do display them. Their logos are of different sizes and you want to make them of similar size. Obviously you do not want to include their logos with your source code due to copyright infringement.

Here is an example of ugly results due to dropping the size elements from the images: https://github.com/pycontribs/jira

…ps width parameter of ..image (see github/markup#295)

ssbarnea · 2016-02-18T17:19:42Z

Guys, any reason why you "sanitize" the size? I don't really see any good reason for doing this operation, is only making the experience much worse.

vitaut · 2016-02-18T17:35:28Z

Scaling status images for different services like Travis is another common use case. They are often of different sizes.

irl · 2016-10-21T20:55:07Z

Seriously? This is mental. It works when for Markdown, but for Python projects it's better to have reStructuredText for the README to avoid having to maintain two README files for GitHub and PyPI. Please reconsider this issue.

ssbarnea · 2016-10-22T15:43:43Z

This bug as many others are good reasons why people are switching to alternatives, like GitLab. They are open source, more open to suggestions and accepting contributions from the community.

irl · 2016-10-22T17:28:13Z

In my case, I'm now shipping a logo in my sources which is really not open source and I'm going to have to remove it again when I do Debian packaging to make sure the package is DFSG compliant. "Sanitising" the heights is really just creating extra work for people. I can see no use case where "sanitising" is useful and no explanation has been given here of why this is the case. I understand GitHub wants to be the definition of open source, and this is good for the GitHub business model, but sometimes it's good to also remember that it exists within an ecosystem and creating extra work for people is a good way to annoy that ecosystem.

Github sanitizes out image size option github/markup#295

Since GitHub reStructuredText doesn't respect image sizing parameters (see github/markup#295) leverage this on-the-fly resizing service that someone sniffed out from Google. (see https://gist.github.com/carlo/5379498) Only downside is that I don't think it's officially supported, so might go away at any time, but it's better than giant logos!

alainbryden · 2017-02-10T16:26:09Z

+1 for this

aclark4life · 2017-08-04T17:54:44Z

Would love it if :width: worked

Works around github/markup#295

* Several updates and fixes. * add image * options for image * absolute path for image URI * Reduce image size, add height/width to RST * Fix dimensions * Move image info to bottom * move back image to top * Make image smaller since width attribute is sanitized. Works around github/markup#295

vi3k6i5 · 2017-09-12T15:13:18Z

@bkeepers please reopen the issue.

lexbailey · 2017-09-13T09:58:35Z

I have just come across this bug too.
I tried to make the build icons larger in my readme: https://github.com/danieljabailey/tweensvg/blob/master/README.rst
but they are still small.

Please reopen.

brooksandrew · 2017-09-23T13:19:06Z

+1

same-id · 2017-10-28T19:38:56Z

+1

jmillxyz · 2017-11-02T20:40:31Z

Hi all, I've found a workaround using reStructuredText's raw directive. For example:

.. raw:: html

    <img src="https://upload.wikimedia.org/wikipedia/commons/0/0c/Cow_female_black_white.jpg" height="400px">

retr0h · 2018-02-09T23:04:51Z

@jondelmil downside to this approach is pypi. If you end up uploading your project to pypi it will treat your README.rst as plain text and not render it properly.

vitaut · 2018-02-09T23:20:49Z

~4 years later this is still broken on GitHub...

LucaCappelletti94 · 2019-11-18T10:46:37Z

Still waiting for a fix... this feels like those threads under songs with comments like "who listens in 2019?".

Please do consider reopening this extremely tedious and seemingly easily fixable error.

github/markup#295

Github's RST rendering is currently broken [1]: does not support image sizing or multiple images per line. PyPI now supports markdown, so we can switch to harmonize with TileDB core repo. [1] github/markup#295

* Remove use of raw directive in README.rst as not allowed on PyPI - Amends PR #819 * Resize image files for Brazil Band plots in README to be 500 px wide - c.f. github/markup#295 * Add twine check of dist to publishing CI tests * Add smaller version of pyhf logo for documentation

selik · 2020-05-19T20:56:16Z

Having this closed/wontfix makes rST a 2nd-class citizen on GitHub. Transitively, that gives the same impression for projects which prefer rST, like Python.

Also removed matchms header, as the logo IS the header. Because image height is ignored by github while rendering rst (github/markup#295 from 2014), I'm using raw html to get the logo the size that I want.

Zethson · 2020-06-04T18:34:42Z

Please reopen this.

…).

Github's RST rendering is currently broken [1]: does not support image sizing or multiple images per line. PyPI now supports markdown, so we can switch to harmonize with TileDB core repo. [1] github/markup#295

Turn big rocket to small rocket when rendered in GitHub. We use raw HTML image element because GitHub has no plans to support RST image widths (github/markup#295), and in that element we use a remote link instead of a relative one because it seems Sphinx does not handle relative links very well outside of proper RST images.

inspired by github/markup#295 (comment) --- Signed-off-by: Brad Chamberlain <bradcray@users.noreply.github.com>

for logo issue, see github/markup#295

GitHub sanitizes the size of figures in their RST renderer (see github/markup#295), so we need to remove the logo (the workaround suggested in that issue of using the RST `raw` directive doesn't work because PyPI rejects the `raw` directive).

brasic · 2021-09-02T02:08:45Z

Just a heads up: width and height attributes are now permitted in RST images.

Thanks you, GitHub: github/markup#295

AndydeCleyre · 2024-04-24T22:38:42Z

Just a heads up: width and height attributes are now permitted in RST images.

Is this working for other folks? It doesn't seem to work still. Does it matter that I am specifying percents for width?

bkeepers closed this as completed May 27, 2014

manuroe added a commit to matrix-org/matrix-ios-kit that referenced this issue Apr 20, 2015

Shrink image to fit 240px width as github reStructuredText parser ski…

97295b2

…ps width parameter of ..image (see github/markup#295)

irl added a commit to mami-project/pathspider that referenced this issue Oct 21, 2016

Add a resized verison of the MAMI logo (see github/markup#295)

b42b850

irl added a commit to mami-project/pathspider that referenced this issue Oct 21, 2016

Really shrink this time (see github/markup#295)

b34bdff

keishinkickback added a commit to keishinkickback/notifycenter-python that referenced this issue Oct 28, 2016

image size bug

5bf69a9

Github sanitizes out image size option github/markup#295

asqui mentioned this issue Nov 15, 2016

Resize images in README.rst pycontribs/jira#285

Merged

nedbat mentioned this issue Mar 1, 2017

Smaller logo psf/requests#3901

Merged

jlandmann mentioned this issue Mar 22, 2017

Resize Images in README jlandmann/crampon#4

Open

marcoskirsch added a commit to ni/nimi-python that referenced this issue Aug 16, 2017

Make image smaller since width attribute is sanitized.

2ed42b9

Works around github/markup#295

JulienPeloton pushed a commit to JulienPeloton/s4cmb that referenced this issue Nov 8, 2017

test resizing with html (all images). see github/markup#295

07d2f53

basnijholt mentioned this issue Dec 11, 2019

WIP: add long_description to setup.py python-adaptive/adaptive#236

Open

sbrugman added a commit to dylan-profiler/visions that referenced this issue Jan 29, 2020

Github rst "sanitizes" image width.

99c91b9

github/markup#295

makdl mentioned this issue Mar 6, 2020

TOC links in README on PyPI don't work StochSS/GillesPy2#214

Closed

ihnorton mentioned this issue Mar 9, 2020

Use markdown for README [ci skip] TileDB-Inc/TileDB-Py#282

Merged

cwmeijer mentioned this issue May 25, 2020

smaller logo on readme matchms/matchms#44

Merged

ericpre mentioned this issue Jun 24, 2020

Add support dolphin hyperspy/start_jupyter_cm#20

Merged

3 tasks

ericpre added a commit to ericpre/start_jupyter_cm that referenced this issue Jun 24, 2020

Use html to adjust the width of the image (github bug github/markup#295…

4aca53e

…).

bobheadxi mentioned this issue Sep 29, 2020

docs: rocket2 logo is an absolute unit in github ubclaunchpad/rocket2#511

Merged

bradcray added a commit to bradcray/chapel that referenced this issue Nov 17, 2020

Attempt 3

3a6ddb3

inspired by github/markup#295 (comment) --- Signed-off-by: Brad Chamberlain <bradcray@users.noreply.github.com>

bocklund added a commit to bocklund/ESPEI that referenced this issue Jan 8, 2021

Update logo size, with raw, fix link

d27c0a6

for logo issue, see github/markup#295

bocklund mentioned this issue Jan 8, 2021

DOC: Update README PhasesResearchLab/ESPEI#141

Merged

chrisburr mentioned this issue Jan 22, 2021

[v7r2] Deploy releases to PyPI DIRACGrid/DIRAC#4906

Merged

yuan-bwn mentioned this issue Apr 29, 2021

Update README.rst aws/aws-step-functions-data-science-sdk-python#130

Merged

OleksandrAnisimo added a commit to OleksandrAnisimo/flask-multipass that referenced this issue Apr 20, 2024

Use PNG image for logo in README

f4f3cca

Thanks you, GitHub: github/markup#295

OleksandrAnisimo added a commit to OleksandrAnisimo/flask-multipass that referenced this issue Apr 20, 2024

Use PNG image for logo in README

dbc9b84

Thanks you, GitHub: github/markup#295

AndydeCleyre added a commit to AndydeCleyre/zpy that referenced this issue Apr 24, 2024

Try workaround for github/markup#295

7610b39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Image height is ignored in RST #295

Image height is ignored in RST #295

vitaut commented Apr 25, 2014

bkeepers commented May 27, 2014

ssbarnea commented Apr 1, 2015

ssbarnea commented Feb 18, 2016

vitaut commented Feb 18, 2016

irl commented Oct 21, 2016

ssbarnea commented Oct 22, 2016

irl commented Oct 22, 2016

alainbryden commented Feb 10, 2017

aclark4life commented Aug 4, 2017

vi3k6i5 commented Sep 12, 2017

lexbailey commented Sep 13, 2017

brooksandrew commented Sep 23, 2017

same-id commented Oct 28, 2017

jmillxyz commented Nov 2, 2017

retr0h commented Feb 9, 2018

vitaut commented Feb 9, 2018

LucaCappelletti94 commented Nov 18, 2019

selik commented May 19, 2020

Zethson commented Jun 4, 2020 •

edited

brasic commented Sep 2, 2021

AndydeCleyre commented Apr 24, 2024

Image height is ignored in RST #295

Image height is ignored in RST #295

Comments

vitaut commented Apr 25, 2014

bkeepers commented May 27, 2014

ssbarnea commented Apr 1, 2015

ssbarnea commented Feb 18, 2016

vitaut commented Feb 18, 2016

irl commented Oct 21, 2016

ssbarnea commented Oct 22, 2016

irl commented Oct 22, 2016

alainbryden commented Feb 10, 2017

aclark4life commented Aug 4, 2017

vi3k6i5 commented Sep 12, 2017

lexbailey commented Sep 13, 2017

brooksandrew commented Sep 23, 2017

same-id commented Oct 28, 2017

jmillxyz commented Nov 2, 2017

retr0h commented Feb 9, 2018

vitaut commented Feb 9, 2018

LucaCappelletti94 commented Nov 18, 2019

selik commented May 19, 2020

Zethson commented Jun 4, 2020 • edited

brasic commented Sep 2, 2021

AndydeCleyre commented Apr 24, 2024

Zethson commented Jun 4, 2020 •

edited