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

API documentation #81

Merged
merged 29 commits into from
Oct 25, 2024
Merged

API documentation #81

merged 29 commits into from
Oct 25, 2024

Commits on Oct 22, 2024

  1. configure the api documentation

    @keewis
    keewis committed Oct 22, 2024
    Configuration menu
    Copy the full SHA
    c0c996a View commit details
    Browse the repository at this point in the history

Commits on Oct 23, 2024

  1. document grid info objects

    @keewis
    keewis committed Oct 23, 2024
    Configuration menu
    Copy the full SHA
    1ff278f View commit details
    Browse the repository at this point in the history

  2. expose the dggs info classes

    @keewis
    keewis committed Oct 23, 2024
    Configuration menu
    Copy the full SHA
    629a248 View commit details
    Browse the repository at this point in the history

  3. generate entries for the grid info objects

    @keewis
    keewis committed Oct 23, 2024
    Configuration menu
    Copy the full SHA
    34afaf2 View commit details
    Browse the repository at this point in the history

  4. add xarray, numpy and pandas intersphinx entries

    @keewis
    keewis committed Oct 23, 2024
    Configuration menu
    Copy the full SHA
    f368584 View commit details
    Browse the repository at this point in the history

  5. install the project

    @keewis
    keewis committed Oct 23, 2024
    Configuration menu
    Copy the full SHA
    b918fe4 View commit details
    Browse the repository at this point in the history

  6. expose the plotting mechanism

    @keewis
    keewis committed Oct 23, 2024
    Configuration menu
    Copy the full SHA
    0c064fd View commit details
    Browse the repository at this point in the history

  7. get the documentation to pass without warnings

    @keewis
    keewis committed Oct 23, 2024
    Configuration menu
    Copy the full SHA
    ac10a8d View commit details
    Browse the repository at this point in the history

  8. minimal docstring for HealpixInfo.nside

    @keewis
    keewis committed Oct 23, 2024
    Configuration menu
    Copy the full SHA
    c39ff12 View commit details
    Browse the repository at this point in the history

  9. minimal docstring for HealpixInfo.nest

    @keewis
    keewis committed Oct 23, 2024
    Configuration menu
    Copy the full SHA
    26d905c View commit details
    Browse the repository at this point in the history

  10. remove Dataset.dggs.explore, which errors currently

    @keewis
    keewis committed Oct 23, 2024
    Configuration menu
    Copy the full SHA
    f986bd2 View commit details
    Browse the repository at this point in the history

  11. docstrings for cell_centers and cell_boundaries

    @keewis
    keewis committed Oct 23, 2024
    Configuration menu
    Copy the full SHA
    ad2468c View commit details
    Browse the repository at this point in the history

  12. document *.dggs.grid_info

    @keewis
    keewis committed Oct 23, 2024
    Configuration menu
    Copy the full SHA
    8a27cea View commit details
    Browse the repository at this point in the history

Commits on Oct 24, 2024

  1. docstring for from_dict

    @keewis
    keewis committed Oct 24, 2024
    Configuration menu
    Copy the full SHA
    082ee65 View commit details
    Browse the repository at this point in the history

Commits on Oct 25, 2024

  1. remove the trailing slash from the toctree dir

    @keewis
    keewis committed Oct 25, 2024
    Configuration menu
    Copy the full SHA
    fcb5e4b View commit details
    Browse the repository at this point in the history

  2. Merge branch 'main' into api

    @keewis
    keewis committed Oct 25, 2024
    Configuration menu
    Copy the full SHA
    b25a3da View commit details
    Browse the repository at this point in the history

  3. document tutorial.open_dataset

    @keewis
    keewis committed Oct 25, 2024
    Configuration menu
    Copy the full SHA
    b65f8ab View commit details
    Browse the repository at this point in the history

  4. clarify the role of the grid names

    @keewis
    keewis committed Oct 25, 2024
    Configuration menu
    Copy the full SHA
    b3f1128 View commit details
    Browse the repository at this point in the history

  5. set some generic aliases

    @keewis
    keewis committed Oct 25, 2024
    Configuration menu
    Copy the full SHA
    24c500f View commit details
    Browse the repository at this point in the history

  6. improve the docstrings of index and coord

    @keewis
    keewis committed Oct 25, 2024
    Configuration menu
    Copy the full SHA
    599e868 View commit details
    Browse the repository at this point in the history

  7. make cell_ids an alias of coord

    @keewis
    keewis committed Oct 25, 2024
    Configuration menu
    Copy the full SHA
    38e931f View commit details
    Browse the repository at this point in the history

  8. restructure the api docs

    @keewis
    keewis committed Oct 25, 2024
    Configuration menu
    Copy the full SHA
    930ef7d View commit details
    Browse the repository at this point in the history

  9. document the healpix grid info object

    @keewis
    keewis committed Oct 25, 2024
    Configuration menu
    Copy the full SHA
    6950d6e View commit details
    Browse the repository at this point in the history

  10. document the h3 grid info class

    @keewis
    keewis committed Oct 25, 2024
    Configuration menu
    Copy the full SHA
    ed64b34 View commit details
    Browse the repository at this point in the history

  11. don't document the valid_parameters class attribute

    @keewis
    keewis committed Oct 25, 2024
    Configuration menu
    Copy the full SHA
    9e7f378 View commit details
    Browse the repository at this point in the history

  12. don't count unique as a valid indexing scheme

    @keewis
    keewis committed Oct 25, 2024
    Configuration menu
    Copy the full SHA
    c9638a9 View commit details
    Browse the repository at this point in the history

  13. Merge branch 'main' into api

    @keewis
    keewis committed Oct 25, 2024
    Configuration menu
    Copy the full SHA
    f73abc4 View commit details
    Browse the repository at this point in the history

  14. document xdggs.decode

    @keewis
    keewis committed Oct 25, 2024
    Configuration menu
    Copy the full SHA
    278f0a2 View commit details
    Browse the repository at this point in the history

  15. link to the documentation in the package metadata

    @keewis
    keewis committed Oct 25, 2024
    Configuration menu
    Copy the full SHA
    c26f4d3 View commit details
    Browse the repository at this point in the history