bp / resqpy

Python API for working with RESQML models
https://resqpy.readthedocs.io/en/latest/
MIT License
51 stars 14 forks source link

Update Sphinx config to V2, and enable docs builds on PRs #767

Closed connortann closed 7 months ago

connortann commented 7 months ago

I saw by email that our ReadtheDocs config format is deprecated, and the build is currently failing. This change should fix it. Link: https://blog.readthedocs.com/migrate-configuration-v2/

Example build now passes successfully: https://readthedocs.org/projects/resqpy/builds/22562103/

I also enabled the setting to build docs on all PRs. This may not take effect for this PR, but should work for future ones.

https://docs.readthedocs.io/page/guides/autobuild-docs-for-pull-requests.html

codecov[bot] commented 7 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (7143897) 81.40% compared to head (59e4153) 81.40%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #767 +/- ## ========================================== - Coverage 81.40% 81.40% -0.01% ========================================== Files 190 190 Lines 32811 32811 ========================================== - Hits 26711 26710 -1 - Misses 6100 6101 +1 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.