Jupyter-book: Docs should specify which image types are supported

[firasm]

Is your feature request related to a problem? Please describe.

Docs should specify which image types are supported

I discovered today that my beautiful vector PDF image is not supported.
I wonder if other formats such as eps, svg etc... are supported ?

A link to the documentation page where you see an issue.

The figures documentation (nor the new images and figures in version 0.8) mentions which figure types are allowed.

Describe the solution you'd like

Update docs with a list of image types supported.

I can update the docs with a PR if someone tells me which formats are supported :-)

[chrisjsewell]

There some open issues about svg support for pdf. PDF/eps -> svg is obviously needed the opposite, needed for HTML support.

Basically you just need a sphinx extension to convert between the two, generally using a converter like imagemagick. There are some that exist, we just haven't "integrated" them into jupyter-book yet.

But it's definitely something I want to solve

[AakashGfude]

@chrisjsewell , I have used https://www.sphinx-doc.org/en/master/usage/extensions/imgconverter.html before and as you mentioned, it uses ImageMagick. handles both gif and SVG for latex. Should we try this one out? https://github.com/missinglinkelectronics/sphinxcontrib-svg2pdfconverter is promoted more as it uses inkscape , but does not handle gif.

[chrisjsewell]

Thanks @AakashGfude yes it would be good to try them. At the very least we can add a link to both in the docs. I think I'll do this in #911

[chrisjsewell]

Note that these issues are also relevant:

• https://github.com/executablebooks/MyST-Parser/issues/176
• https://github.com/executablebooks/MyST-NB/issues/178

[chrisjsewell]

This should be closed in v0.8.0 😄, but feel free to re-open/open another issue if anything is outstanding: https://jupyterbook.org/reference/_changelog.html#v0-8-0-2020-09-01

https://jupyterbook.org/content/figures.html#supported-image-formats