Numark Mixtrack Pro 3: Replace layout image GIF with SVG #297
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Holzhaus
added a commit
to Holzhaus/manual
that referenced
this pull request
Nov 11, 2020
Since LaTeX doesn't support SVG files, we need to convert them to a
format that it can understand. Until now, we used
`sphinx.ext.imgconverter` for that. Unfortunately, that has various
issues:
- It depends on ImageMagick which is buggy on some platforms (e.g. on
the `ubuntu-latest` image in GitHub Actions)
- SVGs are rasterized, so that you can't zoom in losslessly in PDFs
- Rasterization also happens for HTML documentation, even though it's
unnecessary
By replacing it with `sphinxcontrib.rsvgconverter`, all of these are
fixed. For LaTeX, this converts the SVG to a vector PDF which can be
used with `\includegraphics{}`.
What it doesn't do is converting GIF images. These also cause problems
with the LaTeX build, but we didn't notice that because
`sphinx.ext.imgconverter` converted them as well. Fortunately, we only
have 2 GIF images in our source tree and can just use a different
format. Hence, this PR depends on mixxxdj#298 and mixxxdj#297.
Holzhaus
added a commit
to Holzhaus/manual
that referenced
this pull request
Nov 11, 2020
Since LaTeX doesn't support SVG files, we need to convert them to a
format that it can understand. Until now, we used
`sphinx.ext.imgconverter` for that. Unfortunately, that has various
issues:
- It depends on ImageMagick which is buggy on some platforms (e.g. on
the `ubuntu-latest` image in GitHub Actions)
- SVGs are rasterized, so that you can't zoom in losslessly in PDFs
- Rasterization also happens for HTML documentation, even though it's
unnecessary
By replacing it with `sphinxcontrib.rsvgconverter`, all of these are
fixed. For LaTeX, this converts the SVG to a vector PDF which can be
used with `\includegraphics{}`.
What it doesn't do is converting GIF images. These also cause problems
with the LaTeX build, but we didn't notice that because
`sphinx.ext.imgconverter` converted them as well. Fortunately, we only
have 2 GIF images in our source tree and can just use a different
format. Hence, this PR depends on mixxxdj#298 and mixxxdj#297.
|
LGTM |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.