CSHS-CWRA / RavenPy

A Python wrapper to setup and run the hydrologic modelling framework Raven
https://ravenpy.readthedocs.io
MIT License
26 stars 5 forks source link

Add SVG converter, fix PDF rendering on ReadTheDocs #407

Closed Zeitsperre closed 1 month ago

Zeitsperre commented 1 month ago

Pull Request Checklist:

What kind of change does this PR introduce?

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.

coveralls commented 1 month ago

Coverage Status

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