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

Add SVG converter, fix PDF rendering on ReadTheDocs #407

Merged
merged 11 commits into from
Oct 15, 2024
Merged

Conversation

Zeitsperre
Copy link
Member

@Zeitsperre Zeitsperre commented Oct 9, 2024

Pull Request Checklist:

  • This PR addresses an already opened issue (for bug fixes / features)
    • This PR fixes #xyz
  • (If applicable) Documentation has been added / updated (for bug fixes / features).
  • (If applicable) Tests have been added.
  • CHANGELOG.rst has been updated (with summary of main changes).
    • Link to issue (:issue:number) and pull request (:pull:number) has been added.

What kind of change does this PR introduce?

  • Adds an SVG converter to the PDF generating LaTeX dependencies

Does this PR introduce a breaking change?

It should not.

Other information:

What's going on here?

Some changes to the LaTeX engine on ReadTheDocs have been causing the SVG files referenced in the README.rst to be rendered as individual PDF files. I'm not certain why that is happening, but it was causing the latest and stable documentation builds to fail. This PR makes it so that instead of the README.rst being referenced directly by sphinx, instead it is copied and patched to not render the badges when building for PDF. This has fixed the issue.

@Zeitsperre Zeitsperre self-assigned this Oct 9, 2024
@github-actions github-actions bot added the docs label Oct 9, 2024
@coveralls
Copy link

coveralls commented Oct 9, 2024

Coverage Status

coverage: 81.343%. remained the same
when pulling 0099fba on fix-docs
into db12392 on master.

@github-actions github-actions bot added the CI label Oct 10, 2024
@Zeitsperre Zeitsperre marked this pull request as ready for review October 10, 2024 17:28
@Zeitsperre Zeitsperre requested a review from huard October 10, 2024 17:28
@Zeitsperre Zeitsperre changed the title Add svg converter Add SVG converter, fix PDF rendering on ReadTheDocs Oct 10, 2024
Copy link

@aulemahal aulemahal left a comment

Choose a reason for hiding this comment

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

Looks good.

@Zeitsperre Zeitsperre merged commit c3334a1 into master Oct 15, 2024
16 checks passed
@Zeitsperre Zeitsperre deleted the fix-docs branch October 15, 2024 19:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants