Add docs, part 1

CMCC-Foundation · Jan 22, 2024 · bf18bfb · bf18bfb
1 parent 9176f44
commit bf18bfb
Show file tree

Hide file tree

Showing 11 changed files with 86 additions and 0 deletions.
diff --git a/docs/docs/about.md b/docs/docs/about.md
@@ -0,0 +1,6 @@
+# About
+
+## Authors
+
+
+## Acknowledegement
diff --git a/docs/docs/api.md b/docs/docs/api.md
@@ -0,0 +1,5 @@
+# REST API
+
+## Description
+
+## Docstring
diff --git a/docs/docs/broker.md b/docs/docs/broker.md
@@ -0,0 +1,5 @@
+# Broker
+
+## Description
+
+## Docstring
diff --git a/docs/docs/drivers.md b/docs/docs/drivers.md
@@ -0,0 +1,5 @@
+# Drivers
+
+## Description
+
+## Docstring
diff --git a/docs/docs/executor.md b/docs/docs/executor.md
@@ -0,0 +1,5 @@
+# Executor
+
+## Description
+
+## Docstring
diff --git a/docs/docs/img/favicon.svg b/docs/docs/img/favicon.svg
diff --git a/docs/docs/img/logo.svg b/docs/docs/img/logo.svg
diff --git a/docs/docs/index.md b/docs/docs/index.md
@@ -0,0 +1,9 @@
+
+<div align="center">
+<img src="img/logo.svg" width="40%" height="40%">
+</div>
+
+# Welcome to GeoLake
+GeoLake is a framework for managing and processing of geospatial data.
+
+some more description...
diff --git a/docs/docs/installation.md b/docs/docs/installation.md
@@ -0,0 +1 @@
+# Installation
diff --git a/docs/mkdocs.yaml b/docs/mkdocs.yaml
@@ -0,0 +1,43 @@
+site_name: GeoLake
+site_description: GeoLake - an environment for managing and processing geospatial data
+theme:
+  name: material
+  palette:
+  - media: '(prefers-color-scheme: light)'
+    scheme: default
+    primary: blue grey
+    accent: amber
+    toggle:
+      icon: material/lightbulb
+      name: Switch to dark mode
+  - media: '(prefers-color-scheme: dark)'
+    scheme: slate
+    primary: blue grey
+    accent: amber
+    toggle:
+      icon: material/lightbulb-outline
+      name: Switch to light mode
+  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/geolake
+edit_uri: ''
+nav:
+- GeoLake: index.md
+- installation.md
+- References:
+  - drivers.md
+  - broker.md
+  - api.md
+  - executor.md
+- about.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1 @@
+site_name: My Docs