Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Enable API reference docs to show accessor methods #44

Merged
merged 12 commits into from
Jun 21, 2024
Merged

Enable API reference docs to show accessor methods #44

merged 12 commits into from
Jun 21, 2024

Commits on Jun 19, 2024

  1. Install cupy-core and xarray 

    The cupy-core package from conda-forge does not bring in CUDA dependencies and thus can be installed on CPU-only CI services. Xref conda-forge/cupy-feedstock#229
    @weiji14
    weiji14 committed Jun 19, 2024
    Configuration menu
    Copy the full SHA
    db7d88f View commit details
    Browse the repository at this point in the history

  2. Add pip install --editable to docs build instructions 

    Also fixed some typos around doc/docs.
    @weiji14
    weiji14 committed Jun 19, 2024
    Configuration menu
    Copy the full SHA
    830cbec View commit details
    Browse the repository at this point in the history

  3. Re-enable building of API page in docs/conf.py 

    See usage instructions in https://sphinx-autosummary-accessors.readthedocs.io/en/stable/usage.html. Also need to `import cupy_xarray` to fix `exception: no module named xarray.DataArray.cupy` error following xarray-contrib/sphinx-autosummary-accessors#107.
    @weiji14
    weiji14 committed Jun 19, 2024
    Configuration menu
    Copy the full SHA
    63fd759 View commit details
    Browse the repository at this point in the history

  4. Undocument Dataset.cupy.get 

    Fixes `AttributeError: type object 'CupyDatasetAccessor' has no attribute 'get'`
    @weiji14
    weiji14 committed Jun 19, 2024
    Configuration menu
    Copy the full SHA
    3ee419a View commit details
    Browse the repository at this point in the history

  5. [pre-commit.ci] auto fixes from pre-commit.com hooks 

    for more information, see https://pre-commit.ci
    @pre-commit-ci
    pre-commit-ci[bot] committed Jun 19, 2024
    Configuration menu
    Copy the full SHA
    c687298 View commit details
    Browse the repository at this point in the history

  6. Add noqa: F401 to import cupy_xarray line

    @weiji14
    weiji14 committed Jun 19, 2024
    Configuration menu
    Copy the full SHA
    6cc9115 View commit details
    Browse the repository at this point in the history

  7. PIp install cupy_xarray on readthedocs

    @weiji14
    weiji14 committed Jun 19, 2024
    Configuration menu
    Copy the full SHA
    4d35c46 View commit details
    Browse the repository at this point in the history

  8. [pre-commit.ci] auto fixes from pre-commit.com hooks 

    for more information, see https://pre-commit.ci
    @pre-commit-ci
    pre-commit-ci[bot] committed Jun 19, 2024
    Configuration menu
    Copy the full SHA
    3ac183c View commit details
    Browse the repository at this point in the history

  9. Remove numpydoc and use napolean only

    @weiji14
    weiji14 committed Jun 19, 2024
    Configuration menu
    Copy the full SHA
    5087d89 View commit details
    Browse the repository at this point in the history

  10. Put editable install in ci/doc.yml so no need to pip install separately 

    Xref https://docs.readthedocs.io/en/stable/faq.html#i-need-to-install-a-package-in-a-environment-with-pinned-versions
    @weiji14
    weiji14 committed Jun 19, 2024
    Configuration menu
    Copy the full SHA
    ccc1925 View commit details
    Browse the repository at this point in the history

  11. [pre-commit.ci] auto fixes from pre-commit.com hooks 

    for more information, see https://pre-commit.ci
    @pre-commit-ci
    pre-commit-ci[bot] committed Jun 19, 2024
    Configuration menu
    Copy the full SHA
    72ac4e8 View commit details
    Browse the repository at this point in the history

  12. Add minimal docstrings to accessor methods and attributes 

    Adding some docstrings to the is_cupy, as_cupy and as_numpy  methods, so that the API docs page looks like center-aligned.
    @weiji14
    weiji14 committed Jun 19, 2024
    Configuration menu
    Copy the full SHA
    e19967c View commit details
    Browse the repository at this point in the history