Enable API reference docs to show accessor methods

[weiji14]

Previously, the API docs section of cupy-xarray has been disabled on because import cupy doesn't work on Readthedocs CI without CUDA. Luckily, there is now a cupy-core package on conda-forge (see conda-forge/cupy-feedstock#241) that makes CUDA optional, so we can use that to build the API docs!

Preview at https://cupy-xarray--44.org.readthedocs.build/api.html

(Yeah, not sure why some of those API methods are centre-aligned 😅)

I've also updated the 'Contributing documentation' section in the contributing guide which had some typos. Full steps to reproduce the docs build are:

conda env create --file ci/doc.yml
conda activate cupy-xarray-doc

cd docs
make html

References:

• Support lazy import in v13 conda-forge/cupy-feedstock#229
• https://sphinx-autosummary-accessors.readthedocs.io/en/stable/usage.html

Fixes #5

[keewis]

(Yeah, not sure why some of those API methods are centre-aligned 😅)

I think that's because those don't have docstrings (DataArray.cupy.get() doesn't, either, but it shares the table with methods that do have one).

Edit: looks like all of them are centered, just that some of them have longer strings
Edit2: I'd also advise against using numpydoc and napoleon together, they don't always work well together
Edit3: to install the package, I'd follow the recommendation documented by RTD (add -e .. to the pip section in the environment file) – this is also what we're doing in xarray

[weiji14]

Edit2: I'd also advise against using numpydoc and napoleon together, they don't always work well together

Ok, removed numpydoc at commit 5087d89!

Edit3: to install the package, I'd follow the recommendation documented by RTD (add -e .. to the pip section in the environment file) – this is also what we're doing in xarray

Ah yes, I was trying with one dot ., but forgot that two dots .. are needed to move up a directory! Done at ccc1925 (and contributing instruction docs also updated to remove pip install --editable=. part).

Edit: looks like all of them are centered, just that some of them have longer strings

Hmm you're correct, they are all center-aligned. Let me try to play around with the docstrings and/or the sphinx template.

[weiji14]

Ok, couldn't figure out how to remove the center-alignment 😅, I had a look at other xarray-contrib repos using the Furo theme, and it seems like xwrf has the same issue, but cf-xarray doesn't.

So... I just added in the some docstrings to make it look less empty. Maybe @dcherian or someone else can look at cf-xarray's css file and figure out how to remove the centre-alignment issue.

[dcherian]

Nice work @weiji14 I've added you as maintainer so you should be able to click merge here :)

re: center-aligning. I do not recall doing anything specific. Apparently flox has this issue too, i suspect it is a regression in furo

[weiji14]

re: center-aligning. I do not recall doing anything specific. Apparently flox has this issue too, i suspect it is a regression in furo

Ah ok, maybe best to report this upstream then at https://github.com/pradyunsg/furo? I'm not sure whether the API docs in flox or cf-xarray looked like this before, so can't tell if it's a regression bug. It looks as though Furo is centering tables by default, so maybe we need a directive to left align it, but I couldn't find out exactly how.

Nice work @weiji14 I've added you as maintainer so you should be able to click merge here :)

Thanks! You must have read my mind. Secretly, I've been hoping to get maintainer access after this PR because I have some free time next week, so maybe (just maybe) I'll put in some time to update #10 😈

Will leave this open a bit longer in case anyone has other suggestions, otherwise I'll go ahead and merge this sometime tomorrow.