Merge pull request #10 from CMCC-Foundation/release_0.3_docs

Release 0.3 docs

docs/about.md

@@ -0,0 +1,10 @@
+# About
+
+## Authors
+Following authors contributed to the `geokube` framework.
+
+| Authors             |
+|--------------------|
+| Marco Mancini    <a href="https://orcid.org/0000-0002-9150-943X"><img alt="ORCID logo" src="https://info.orcid.org/wp-content/uploads/2019/11/orcid_16x16.png" width="16" height="16" /></a>  |
+| Mirko Stojiljković <a href="https://orcid.org/0000-0003-2256-1645"><img alt="ORCID logo" src="https://info.orcid.org/wp-content/uploads/2019/11/orcid_16x16.png" width="16" height="16" /></a> |
+| Jakub Walczak   <a href="https://orcid.org/0000-0002-5632-9484"><img alt="ORCID logo" src="https://info.orcid.org/wp-content/uploads/2019/11/orcid_16x16.png" width="16" height="16" /></a>   |

docs/axis.md

@@ -0,0 +1 @@
+::: geokube.core.axis

docs/coord_system.md

@@ -0,0 +1 @@
+::: geokube.core.coord_system

docs/crs.md

@@ -0,0 +1 @@
+::: geokube.core.crs

docs/domain.md

@@ -0,0 +1 @@
+::: geokube.core.domain

docs/feature.md

@@ -0,0 +1 @@
+::: geokube.core.feature

docs/field.md

@@ -0,0 +1 @@
+::: geokube.core.field

docs/index.md

@@ -0,0 +1,5 @@
+# Welcome to geokube
+
+**geokube** is an open source Python package for geoscience data analysis that provides the user with a simple application programming interface (API) for performing geospatial operations (e.g., extracting a bounding box or regridding) and temporal operations (e.g., resampling) on different types of scientific feature types like grids, profiles and points, using on `xarray` data structures like `xarray.Dataset` and custom `xarray.Dataset.indexes` and xarray ecosystem frameworks such as `xesmf` and `cf-xarray`.
+
+Furthermore, based on xarray IO engines, geokube provides built-in drivers for reading geoscientific datasets produced by Earth Observations (e.g. satellite data) and Earth Systems Models (e.g., weather, climate and oceanographic models)

mkdocs.yml

@@ -0,0 +1,40 @@
+site_name: geokube
+site_description: geokube - a Python package based on xarray for Geoscience Data Analysis and Visualization
+theme:
+  name: material
+  palette:
+  - media: '(prefers-color-scheme: light)'
+    scheme: default
+    primary: blue grey
+    accent: amber
+  features:
+  - search.suggest
+  - search.highlight
+  - content.tooltips
+  - content.code.annotate
+  - content.code.copy
+  - content.code.select
+  icon:
+    repo: fontawesome/brands/github-alt
+  logo: img/favicon.svg
+  favicon: img/favicon.svg
+  language: en
+repo_name: CMCC-Foundation/geolake
+repo_url: https://github.com/CMCC-Foundation/geokube
+edit_uri: ''
+use_directory_urls: false
+
+plugins:
+- mkdocstrings:
+
+nav:
+- geokube: index.md
+- API:
+  - axis.md
+  - crs.md
+  - coord_system.md
+  - feature.md
+  - domain.md
+  - field.md
+- about.md
+