search

xarray-contrib / cf-xarray

an accessor for xarray objects that interprets CF attributes
https://cf-xarray.readthedocs.io/
Apache License 2.0
152 stars 39 forks source link

Fix docs build #480

Closed jsignell closed 7 months ago

jsignell commented 7 months ago

Docs build is broken on main. This seems to fix it locally. Ref: https://github.com/sphinx-doc/sphinx/issues/11094#issuecomment-1372994091

jsignell commented 7 months ago

I'm working through the numpydocs warnings now as well.

dcherian commented 7 months ago

Thank you!

codecov[bot] commented 7 months ago

Codecov Report

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

Comparison is base (f9034ac) 86.11% compared to head (323a881) 63.60%. Report is 1 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #480 +/- ## =========================================== - Coverage 86.11% 63.60% -22.51% =========================================== Files 22 22 Lines 4220 4212 -8 Branches 223 223 =========================================== - Hits 3634 2679 -955 - Misses 526 1449 +923 - Partials 60 84 +24 ``` | [Flag](https://app.codecov.io/gh/xarray-contrib/cf-xarray/pull/480/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=xarray-contrib) | Coverage Δ | | |---|---|---| | [mypy](https://app.codecov.io/gh/xarray-contrib/cf-xarray/pull/480/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=xarray-contrib) | `37.95% <100.00%> (-0.03%)` | :arrow_down: | | [unittests](https://app.codecov.io/gh/xarray-contrib/cf-xarray/pull/480/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=xarray-contrib) | `93.91% <100.00%> (-1.96%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=xarray-contrib#carryforward-flags-in-the-pull-request-comment) to find out more.

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

jsignell commented 7 months ago

Ok all the warnings are gone locally. I'll watch the PR readthedocs build to confirm that that's the case there as well.

The big changes are in fc2ea8cf7fe222d9efe20a466f1725082d87b4ee where I exclude some methods/files and ignore some classes of warnings.

dcherian commented 7 months ago

A lot fewer! I don';t mind merging with these.

WARNING: [numpydoc] Validation warnings while processing docstring for 'cf_xarray.set_options':
  PR01: Parameters {'**kwargs'} not documented
  PR02: Unknown parameters {'warn_on_missing_variables', 'custom_criteria'}

WARNING: [numpydoc] Validation warnings while processing docstring for 'xarray.DataArray.cf.formula_terms':
  SS06: Summary should fit in a single line

WARNING: [numpydoc] Validation warnings while processing docstring for 'xarray.DataArray.cf.differentiate':
  PR01: Parameters {'*xr_args', '**xr_kwargs'} not documented

WARNING: [numpydoc] Validation warnings while processing docstring for 'xarray.Dataset.cf.formula_terms':
  SS06: Summary should fit in a single line

WARNING: [numpydoc] Validation warnings while processing docstring for 'xarray.Dataset.cf.differentiate':
  PR01: Parameters {'*xr_args', '**xr_kwargs'} not documented

WARNING: [numpydoc] Validation warnings while processing docstring for 'cf_xarray.set_options':
  PR01: Parameters {'**kwargs'} not documented
  PR02: Unknown parameters {'warn_on_missing_variables', 'custom_criteria'}

WARNING: [numpydoc] Validation warnings while processing docstring for 'xarray.DataArray.cf.differentiate':
  PR01: Parameters {'*xr_args', '**xr_kwargs'} not documented

WARNING: [numpydoc] Validation warnings while processing docstring for 'xarray.DataArray.cf.formula_terms':
  SS06: Summary should fit in a single line

WARNING: [numpydoc] Validation warnings while processing docstring for 'xarray.Dataset.cf.differentiate':
  PR01: Parameters {'*xr_args', '**xr_kwargs'} not documented

WARNING: [numpydoc] Validation warnings while processing docstring for 'xarray.Dataset.cf.formula_terms':
  SS06: Summary should fit in a single line
jsignell commented 7 months ago

A lot fewer! I don't mind merging with these.

Yeah this is numpydoc 1.5.0 (RTD) vs 1.6.0 (what I have locally). The more revent version is better at handling the inline ignore comments. So yeah I agree. I am happy merging as is