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

Re-organize documentation to list features independently of data objects #565

Merged
merged 15 commits into from
Jun 14, 2024

Conversation

rhugonnet
Copy link
Contributor

@rhugonnet rhugonnet commented Jun 12, 2024

This PR updates the documentation structure to describe "Features" in specific sections with nice plots, which makes those more visible and accessible (rather than being stacked in the API/example, or object definitions).

The "Geospatial data objects" become a single section, containing the multiple data types, which will allow to easily add the Xarray accessor (and potentially Geopandas accessor) with limited changes (as they will have the exact same features and API as presented in this new documentation).

This PR also documents pixel interpretation in a section of "Referencing" and the new "Configuration" parameters for the first time, and most point cloud features (in preparation for a 0.2 release with the new PointCloud class).

Resolves #574
Resolves #576
Resolves #523

doc/source/distance_ops.md Outdated Show resolved Hide resolved
doc/source/index.md Outdated Show resolved Hide resolved
doc/source/api.md Outdated Show resolved Hide resolved
@adehecq
Copy link
Member

adehecq commented Jun 13, 2024

I'm just thinking. I'm not sure how well nodata are discussed in the current documentation. Maybe we could have a subsection explaining nodata, when and how they are used, and how to handle the mask and update it (with set_mask). Sometimes people get confused on how to handle it.

@rhugonnet rhugonnet reopened this Jun 13, 2024
@rhugonnet rhugonnet marked this pull request as ready for review June 14, 2024 01:49
@rhugonnet rhugonnet merged commit 65266d5 into GlacioHack:main Jun 14, 2024
12 checks passed
@rhugonnet rhugonnet deleted the reorg_doc branch June 14, 2024 07:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants