Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Install 'rsvg-convert' #79

Merged
merged 2 commits into from
Jan 2, 2019
Merged

Install 'rsvg-convert' #79

merged 2 commits into from
Jan 2, 2019

Conversation

mgeier
Copy link
Contributor

@mgeier mgeier commented Nov 12, 2018

See #78.

This is untested, I hope it works!

This was referenced Nov 12, 2018
Closed
Closed
@humitos humitos mentioned this pull request Nov 14, 2018
Closed
humitos
humitos approved these changes Nov 14, 2018
View reviewed changes
Dockerfile
@@ -48,6 +48,9 @@ RUN apt-get -y install \
latex-cjk-chinese-arphic-gbsn00lp latex-cjk-chinese-arphic-gkai00mp \
fonts-symbola

# Install 'rsvg-convert' for SVG -> PDF conversion
RUN apt-get -y install librsvg2-bin
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would add a comment here with this link also, https://github.com/missinglinkelectronics/sphinxcontrib-svg2pdfconverter

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done: 80f52ba

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😍

lentinj added a commit to mahlberg-lab/clic that referenced this pull request Dec 6, 2018
@lentinj
docs: Add CLiC screenshot as PDF logo
b769795 
readthedocs doesn't support converting the SVG logo to PDF, so we can use it in LaTeX.

Ideally we would use https://github.com/sephalon/sphinxcontrib-svg2pdfconverter
and convert to PDF, but rsvg-convert isn't available in RTD yet:

    readthedocs/readthedocs-docker-images#78
    readthedocs/readthedocs-docker-images#79
@mgeier mgeier mentioned this pull request Dec 6, 2018
Closed
@humitos humitos merged commit f685583 into readthedocs:master Jan 2, 2019
@mgeier mgeier deleted the patch-3 branch January 2, 2019 12:42
@mgeier
Copy link
Contributor Author

mgeier commented Jan 2, 2019

Thanks for merging!

How is the release process of this image?

When will it be available on readthedocs.org?

@stsewd
Copy link
Member

stsewd commented Jan 2, 2019

@mgeier here is some discussion about it #84

@humitos humitos mentioned this pull request Jan 7, 2019
Merged
@humitos
Copy link
Member

humitos commented Jan 14, 2019

Hi all! rsvg-convert was installed in our latest testing image 5.0rc1 (not released yet). I'd like to know if you want to help us testing it. In that case, please let me know what are the projects you are interested on testing it and I will apply this Docker image for its building process.

@mgeier
Copy link
Contributor Author

mgeier commented Jan 14, 2019

@humitos

I have a branch for testing it here: https://nbsphinx.readthedocs.io/en/rsvg/

It would be great if you could give it a try!

Currently the build passes but building the LaTeX output results in:

WARNING: RSVG converter command 'rsvg-convert' cannot be run. Check the rsvg_converter_bin setting

... and the SVG images are not shown.

As soon as it works, there should be a few SVG images in the resulting PDF, e.g. there:
https://media.readthedocs.org/pdf/nbsphinx/rsvg/nbsphinx.pdf#subsubsection.3.5.1

@humitos
Copy link
Member

humitos commented Jan 14, 2019

Hrm... It failed, but with another error https://readthedocs.org/projects/nbsphinx/builds/8391747/

Any clue?

BTW, I love nbsphinx ;)

@mgeier
Copy link
Contributor Author

mgeier commented Jan 14, 2019

Hmm .. no idea. I'm wondering why xpdf is mentioned in the error ...

BTW, I love nbsphinx ;)

Cool, thanks!

@humitos
Copy link
Member

humitos commented Jan 16, 2019

@mgeier would you like to open an issue in the .org repository so we can get more eyes on it and maybe other people can help us to debug/research?

@mgeier
Copy link
Contributor Author

mgeier commented Jan 24, 2019

@humitos I think there is actually a different issue involved, regarding auto-downloading of remote files. I'll investigate further an come back as soon as I know more ...

@papadop papadop mentioned this pull request Feb 13, 2019
Merged
@mgeier
Copy link
Contributor Author

mgeier commented Sep 25, 2019

Just a little follow-up:

I think there is actually a different issue involved

It was indeed a different issue. A single SVG file was somehow broken, see spatialaudio/nbsphinx#319

In the end rsvg-convert works great on RTD, thanks for making this possible!

@amotl amotl mentioned this pull request Sep 15, 2020
Closed
@proppy proppy mentioned this pull request Oct 20, 2022
Merged
@mgeier
Copy link
Contributor Author

mgeier commented Feb 25, 2023

It looks like this has been reverted in #166.

Was this intentional?

@humitos
Copy link
Member

humitos commented Feb 27, 2023

@mgeier with the new build.apt_packages config file key, users can install APT packages https://docs.readthedocs.io/en/stable/config-file/v2.html#build-apt-packages. Due to that, this package is not required anymore to be installed by default.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@humitos humitos humitos approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@mgeier @stsewd @humitos