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 svgconverter for badges in documentation LaTeX #1296

Merged
merged 5 commits into from Feb 27, 2023
Merged

Conversation

Zeitsperre
Copy link
Collaborator

@Zeitsperre Zeitsperre commented Feb 14, 2023

Pull Request Checklist:

  • This PR addresses an already opened issue (for bug fixes / features)
    • This PR fixes #xyz
  • Tests for the changes have been added (for bug fixes / features)
    • (If applicable) Documentation has been added / updated (for bug fixes / features)
  • HISTORY.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 a converter for the SVG items present in our README (needed for PDF generation)

Does this PR introduce a breaking change?

Some dependencies are added.

Other information:

This should fix the following warnings on RtD:

resolving references...
/home/docs/checkouts/readthedocs.org/user_builds/xclim/checkouts/latest/README.rst:: WARNING: a suitable image for latex builder not found: ['image/svg+xml'] (https://img.shields.io/pypi/v/xclim.svg)
/home/docs/checkouts/readthedocs.org/user_builds/xclim/checkouts/latest/README.rst:: WARNING: a suitable image for latex builder not found: ['image/svg+xml'] (https://img.shields.io/conda/vn/conda-forge/xclim.svg)
/home/docs/checkouts/readthedocs.org/user_builds/xclim/checkouts/latest/README.rst:: WARNING: a suitable image for latex builder not found: ['image/svg+xml'] (https://readthedocs.org/projects/xclim/badge)
/home/docs/checkouts/readthedocs.org/user_builds/xclim/checkouts/latest/README.rst:: WARNING: a suitable image for latex builder not found: ['image/svg+xml'] (https://badges.gitter.im/Ouranosinc/xclim.svg)
/home/docs/checkouts/readthedocs.org/user_builds/xclim/checkouts/latest/README.rst:: WARNING: a suitable image for latex builder not found: ['image/svg+xml'] (https://img.shields.io/github/license/Ouranosinc/xclim.svg)
/home/docs/checkouts/readthedocs.org/user_builds/xclim/checkouts/latest/README.rst:: WARNING: a suitable image for latex builder not found: ['image/svg+xml'] (https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8B-yellow)
/home/docs/checkouts/readthedocs.org/user_builds/xclim/checkouts/latest/README.rst:: WARNING: a suitable image for latex builder not found: ['image/svg+xml'] (https://zenodo.org/badge/142608764.svg)
/home/docs/checkouts/readthedocs.org/user_builds/xclim/checkouts/latest/README.rst:: WARNING: a suitable image for latex builder not found: ['image/svg+xml'] (https://github.com/Ouranosinc/xclim/workflows/xclim/badge.svg)
/home/docs/checkouts/readthedocs.org/user_builds/xclim/checkouts/latest/README.rst:: WARNING: a suitable image for latex builder not found: ['image/svg+xml'] (https://results.pre-commit.ci/badge/github/Ouranosinc/xclim/master.svg)
/home/docs/checkouts/readthedocs.org/user_builds/xclim/checkouts/latest/README.rst:: WARNING: a suitable image for latex builder not found: ['image/svg+xml'] (https://coveralls.io/repos/github/Ouranosinc/xclim/badge.svg)
/home/docs/checkouts/readthedocs.org/user_builds/xclim/checkouts/latest/README.rst:: WARNING: a suitable image for latex builder not found: ['image/svg+xml'] (https://img.shields.io/badge/code%20style-black-000000.svg)
/home/docs/checkouts/readthedocs.org/user_builds/xclim/checkouts/latest/README.rst:: WARNING: a suitable image for latex builder not found: ['image/svg+xml'] (https://bestpractices.coreinfrastructure.org/projects/6041/badge)
/home/docs/checkouts/readthedocs.org/user_builds/xclim/checkouts/latest/README.rst:: WARNING: a suitable image for latex builder not found: ['image/svg+xml'] (https://badges.gitter.im/Ouranosinc/xclim.svg)

@Zeitsperre Zeitsperre added the bug Something isn't working label Feb 14, 2023
@Zeitsperre Zeitsperre added this to the v0.41 milestone Feb 14, 2023
@Zeitsperre Zeitsperre self-assigned this Feb 14, 2023
@github-actions github-actions bot added the docs Improvements to documenation label Feb 14, 2023
Copy link
Collaborator

@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.

I don't know who reads the doc in LaTeX, but if this makes it kawaï, I'm in.

@github-actions github-actions bot added the approved Approved for additional tests label Feb 27, 2023
@Zeitsperre Zeitsperre merged commit c866f35 into master Feb 27, 2023
@Zeitsperre Zeitsperre deleted the fix_docs branch February 27, 2023 17:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Approved for additional tests bug Something isn't working docs Improvements to documenation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants