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.

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

DOC: Enhance the documentation #30

Open
remi-braun opened this issue Dec 12, 2024 · 0 comments
Open

DOC: Enhance the documentation #30

remi-braun opened this issue Dec 12, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@remi-braun
Copy link
Member

Enhance documentation, following these axis:

  • Add notebooks, one per usecases or per module (?)
  • Link other documentations in intersphinx_mapping
    • cloudpathlib for CloudPath
    • xarray for DataArray / Dataset
    • geopandas for GeoDataFrames
    • numpy ?
  • Add examples for functions that miss some
  • Add :py:func: to create links to relevant functions
  • Add :any: to create cross-references (see https://www.sphinx-doc.org/en/master/usage/referencing.html#role-any)
  • Add external reference to the libraries mentioned above (i.e. :class:`rasterio:rasterio.enums.Resampling` )
  • Double ticks to add formatted text
  • Change .. WARNING:: to Warnings
  • ...

See fb7f636 for an overview of what should be done 🔥

@remi-braun remi-braun added the enhancement New feature or request label Dec 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant