pytroll / pyresample

Geospatial image resampling in Python
http://pyresample.readthedocs.org
GNU Lesser General Public License v3.0
344 stars 95 forks source link

Add configuration for readthedocs to fail on warnings #518

Closed djhoese closed 1 year ago

djhoese commented 1 year ago

I noticed that some of the RTD builds had warnings due to bad formatting, but the builds weren't failing. I'd like to know as soon as possible that something isn't building as expected. This sets the proper option for RTD.

codecov[bot] commented 1 year ago

Codecov Report

Merging #518 (cd13f27) into main (3fa9529) will not change coverage. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #518   +/-   ##
=======================================
  Coverage   94.32%   94.32%           
=======================================
  Files          79       79           
  Lines       12944    12944           
=======================================
  Hits        12209    12209           
  Misses        735      735           
Flag Coverage Δ
unittests 94.32% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

djhoese commented 1 year ago

So RTD for pull requests is now a CI job so it would be one of the checks to fail in a PR. I'm not sure if we can get notifications about it but that would be nice. I'm also noticing that we still have the GitHub Actions-based website job. I'll remove that since it isn't necessary now.

mraspaud commented 1 year ago

So RTD for pull requests is now a CI job so it would be one of the checks to fail in a PR.

Ah good point, so we would see the failure in the checks box. That's good enough for me.

mraspaud commented 1 year ago

I'll remove that since it isn't necessary now.

Do you want to do this here or should that be another PR?

djhoese commented 1 year ago

I'll do it here.