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.

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

Sort out image support in reports #24

Closed
1 task
nahueespinosa opened this issue Mar 4, 2022 · 3 comments
Closed
1 task

Sort out image support in reports #24

nahueespinosa opened this issue Mar 4, 2022 · 3 comments
Assignees
Labels
enhancement New feature or request needs-work Ready to be worked on

Comments

@nahueespinosa
Copy link
Member

Description

When using Sphinx for PDF report generation (#20), we need to rely on ImageConverters to convert images that are not supported by the builder (pdflatex only supports PDF, PNG and JPEG image formats).

The current implementation of ImageConverter only uses the image basename to store the converted image in the images directory. This means that if we have an image with the same name in different subdirectories, the converted images will overwrite each other. See this handle function and this utility function using the basename of the source path.

Definition of Done

  • Add support for SVG, PGM and other image formats to lambkin report generation process.

Additional considerations

Possible solutions:

  • We can have the user specify a given output image format to lambkin during benchmark configuration, so we generate the formats supported by the builder.
  • We could flatten the image paths before generating the report and use ImageConverters.
  • We could submit a patch upstream and hope for the best.
@hidmic
Copy link
Collaborator

hidmic commented Mar 4, 2022

We could submit a patch upstream and hope for the best.

This one would be best, but yeah, I fear Sphinx release cadence.

We can have the user specify a given output image format to lambkin during benchmark configuration, so we generate the formats supported by the builder.

Now that I think of it, we should probably always generate PNGs. AFAIK it's the PDF of image formats.

@hidmic hidmic self-assigned this Feb 10, 2023
@hidmic
Copy link
Collaborator

hidmic commented Feb 10, 2023

I think that, for the time being, switching to PNG images is probably simplest so I'll go for it.

@hidmic hidmic changed the title Add support for SVG images in reports Sort out image support in reports Feb 10, 2023
@hidmic hidmic mentioned this issue Apr 12, 2023
6 tasks
@hidmic hidmic added the needs-work Ready to be worked on label Apr 12, 2023
@hidmic
Copy link
Collaborator

hidmic commented May 3, 2023

As of #35, we use PNGs everywhere.

@hidmic hidmic closed this as completed May 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request needs-work Ready to be worked on
Projects
None yet
Development

No branches or pull requests

2 participants