docs update and frontend build

HugoIsNotBoss · Oct 20, 2021 · fa0b1a8 · fa0b1a8
1 parent 51b20dc
commit fa0b1a8
Show file tree

Hide file tree

Showing 32 changed files with 610 additions and 194 deletions.
diff --git a/DependecyMap.md b/DependecyMap.md
@@ -0,0 +1,11 @@
+# Tracking the dependency of python version
+
+## Error: Python 3.8.9
+
+```shell
+
+File "/Users/adi/.pyenv/versions/3.8.9/envs/greppo-lib-test/lib/python3.8/site-packages/greppo/input_types/bar_chart.py", line 9, in Dataset
+    data: list[Any]
+TypeError: 'type' object is not subscriptable
+
+```
diff --git a/Makefile b/Makefile
@@ -3,47 +3,30 @@
 .ONESHELL:
 
 .PHONY: all
-all: hello development
-
-.PHONY: hello
-hello:
-	@echo " "
-	@echo "Hello World..."
-	@echo " "
-	@echo "This is greppo."
-	@echo " "
-	@echo "An open-source platform build and deploy your geo-spatial web-applications."
-	@echo " "
-	@echo "Development is underway."
-	@echo " "
+all: clean
 
 .PHONY: serve-dev
 serve-dev:
 	npm run --prefix ./frontend serve & python ./tests/test_server/test.py &
 
-.PHONY: dev-init
-dev-init:
-	@cd frontend ; npm install
+# @cd frontend ; npm run build
 
-.PHONY: build-vue
-build-vue:
-	@cd frontend ; npm run build
+.PHONY: build-frontend
+build-frontend:	
+	cd frontend && npm run build
 
-.PHONY: serve-vue
-serve-vue:
-	@cd frontend ; npm run serve
-
-.PHONY: serve-star
-serve-star:
-	@cd tests/test_server ; python test.py
+.PHONY: build-package
+build-package:	
+	cd library && python -m build
 
 .PHONY: run-unit-tests
 run-unit-tests:
 	pytest library/tests/unit_tests
 
-.PHONY: build-html-docs
-build-docs:
-	# Sphinx should be installed before doing this
+# Sphinx should be installed before doing this
+# cd library && sphinx-apidoc -f -o ../docs/source/ src
+.PHONY: build-docs
+build-docs:	
 	cd library && sphinx-apidoc -f -o ../docs/source/ src
 	cd docs && make html
 

diff --git a/docs/Makefile b/docs/Makefile
@@ -18,3 +18,11 @@ help:
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+# Rebuild Sphinx documentation on changes, with live-reload in the browser.
+# This will start a server at http://127.0.0.1:8000 and start watching for changes 
+# in the docs/ directory. When a change is detected in docs/, the documentation is 
+# rebuilt and any open browser windows are reloaded automatically. 
+# KeyboardInterrupt (ctrl+c) will stop the server.
+livehtml:
+	sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -11,21 +11,24 @@
 import os
 import sys
 
-sys.path.insert(0, os.path.abspath("../../library/"))
+sys.path.insert(0, os.path.abspath("../../library/src"))
 
 # -- Project information -----------------------------------------------------
 
 project = "Greppo"
 copyright = "2021, Adithya Krishnan, Sarma Tangirala"
 author = "Adithya Krishnan, Sarma Tangirala"
 
+# The full version, including alpha/beta/rc tags
+release = '0.0.1'
 
 # -- General configuration ---------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["sphinx.ext.duration", "sphinx.ext.autodoc"]
+extensions = ["sphinx.ext.duration", "sphinx.ext.autodoc",
+              "myst_parser", "sphinx_copybutton"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
@@ -41,7 +44,8 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "alabaster"
+#html_theme = "alabaster"
+html_theme = "furo"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

diff --git a/docs/source/demo.md b/docs/source/demo.md
@@ -0,0 +1 @@
+# Demo
diff --git a/docs/source/index.md b/docs/source/index.md
@@ -0,0 +1,39 @@
+# Greppo
+
+## Welcome to Greppo's documentation!
+
+**Greppo** is a Python library that makes it easy for Data Scientists to quickly
+build geo-spatial apps using Python and GeoPandas constructs. The library
+provides front-end components driven by simple Greppo interfaces.
+
+{code}`greppo.line_chart(df.read_csv('path/to/csv'))`
+
+Check out the [Quickstart](quickstart) section for further information, and [link](installation) to get started with using
+the project.
+
+```{toctree}
+:hidden:
+
+installation
+quickstart
+demo
+modules
+```
+
+```{toctree}
+:caption: Interfacing Components
+:hidden:
+
+map-components/index
+input-components/index
+```
+
+```{toctree}
+:caption: Inside Greppo
+:hidden:
+
+mental-model
+roadmap
+license
+GitHub Repository <https://github.com/greppo-io/greppo>
+```
diff --git a/docs/source/input-components/index.md b/docs/source/input-components/index.md
@@ -0,0 +1,9 @@
+# Input components
+
+```{toctree}
+:hidden:
+
+number
+select
+multiselect
+```
diff --git a/docs/source/input-components/multiselect.md b/docs/source/input-components/multiselect.md
@@ -0,0 +1 @@
+# Multi-select
diff --git a/docs/source/input-components/number.md b/docs/source/input-components/number.md
@@ -0,0 +1 @@
+# Number
diff --git a/docs/source/input-components/select.md b/docs/source/input-components/select.md
@@ -0,0 +1 @@
+# Select
diff --git a/docs/source/license.md b/docs/source/license.md
@@ -0,0 +1,3 @@
+# License
+
+## MIT
diff --git a/docs/source/map-components/base-layer.md b/docs/source/map-components/base-layer.md
@@ -0,0 +1,19 @@
+# Base layer
+
+## greppo.layers.base_layer module
+
+```{eval-rst}
+.. automodule:: greppo.layers.base_layer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```
+
+## greppo.layers.overlay_layer module
+
+```{eval-rst}
+.. automodule:: greppo.layers.overlay_layer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```
diff --git a/docs/source/map-components/draw-feature.md b/docs/source/map-components/draw-feature.md
@@ -0,0 +1 @@
+# Draw feature
diff --git a/docs/source/map-components/index.md b/docs/source/map-components/index.md
@@ -0,0 +1,9 @@
+# Map components
+
+```{toctree}
+:hidden:
+
+base-layer
+overlay-layer
+draw-feature
+```
diff --git a/docs/source/map-components/overlay-layer.md b/docs/source/map-components/overlay-layer.md
@@ -0,0 +1 @@
+# Overlay layer
diff --git a/docs/source/quickstart.md b/docs/source/quickstart.md
@@ -0,0 +1 @@
+# Quickstart 
diff --git a/docs/source/roadmap.md b/docs/source/roadmap.md
@@ -0,0 +1 @@
+# Roadmap
diff --git a/docs/source/src.input_types.rst b/docs/source/src.input_types.rst
diff --git a/docs/source/src.layers.rst b/docs/source/src.layers.rst
diff --git a/docs/source/src.rst b/docs/source/src.rst
diff --git a/frontend/package.json b/frontend/package.json
@@ -4,7 +4,7 @@
   "private": true,
   "scripts": {
     "serve": "vue-cli-service serve",
-    "build": "vue-cli-service build --dest ../library/static",
+    "build": "vue-cli-service build --dest ../library/src/greppo/static",
     "lint": "vue-cli-service lint"
   },
   "dependencies": {