Fix docs build

[jsignell]

Docs build is broken on main. This seems to fix it locally. Ref: sphinx-doc/sphinx#11094 (comment)

[jsignell]

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

[dcherian]

Thank you!

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

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

@@             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	Coverage Δ
mypy	37.95% <100.00%> (-0.03%)	⬇️
unittests	93.91% <100.00%> (-1.96%)	⬇️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[jsignell]

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 fc2ea8c where I exclude some methods/files and ignore some classes of warnings.

[dcherian]

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]

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