From 23c7639434a18336bf52d88af3fe65b2654c858a Mon Sep 17 00:00:00 2001 From: Nathanael Wong Date: Tue, 8 Oct 2024 17:11:16 -0400 Subject: [PATCH] Link to supported grid types in documentation --- docs/src/index.md | 3 +++ docs/src/regiongrids.md | 8 +++++--- docs/src/types/index.md | 30 ++++++++++++++++++++++++++++++ 3 files changed, 38 insertions(+), 3 deletions(-) create mode 100644 docs/src/types/index.md diff --git a/docs/src/index.md b/docs/src/index.md index 84b8a16..2a0f720 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -13,6 +13,9 @@ hero: - theme: brand text: Getting Started link: /regiongrids + - theme: alt + text: Grid Types + link: /types - theme: alt text: Tutorials link: /tutorials diff --git a/docs/src/regiongrids.md b/docs/src/regiongrids.md index 74e1f61..7852578 100644 --- a/docs/src/regiongrids.md +++ b/docs/src/regiongrids.md @@ -14,10 +14,12 @@ The `RegionGrid` abstract type has three subtypes: 2. `GeneralizedGrid` type, which is for the extraction of data on non-rectilinear lon-lat grids, such as a curvilinear grid. 3. `UnstructuredGrid` type, which is for the extraction of data on unstructured lon-lat grids such as a cubed-spherical grid, or an unstructured mesh. +Each of these types is in turn subdivided into **two** subtypes, (1) a `-Mask` type and (2) a `-Tilt` type. The `-Tilt` types are the same as the `-Mask` types, but with additional fields that specify the _rotation_ of fields. + +More information can be found [here](/types) + ```@docs RectilinearGrid GeneralizedGrid UnstructuredGrid -``` - -Each of these types is in turn subdivided into **two** subtypes, (1) a `-Mask` type and (2) a `-Tilt` type. The `-Tilt` types are the same as the `-Mask` types, but with additional fields that specify the _rotation_ of fields. \ No newline at end of file +``` \ No newline at end of file diff --git a/docs/src/types/index.md b/docs/src/types/index.md new file mode 100644 index 0000000..670d5dd --- /dev/null +++ b/docs/src/types/index.md @@ -0,0 +1,30 @@ +```@raw html + + +# Types of GeoRegions + + +``` \ No newline at end of file