Merge pull request #2 from highcharts-for-python/develop

Preliminary set of demos

Author: hcpchris

.gitignore

@@ -109,6 +109,7 @@ venv/
 ENV/
 env.bak/
 venv.bak/
+.py310/
 
 # Spyder project settings
 .spyderproject

.pre-commit-config.yaml

@@ -0,0 +1,9 @@
+repos:
+  - repo: local
+    hooks:
+      - id: jupyter-nb-clear-output
+        name: jupyter-nb-clear-output
+        files: .*/.*/.*\.ipynb
+        stages: [commit]
+        language: system
+        entry: jupyter-nbconvert --ClearOutputPreprocessor.enabled=True --inplace

README.md

@@ -1,2 +1,57 @@
-# highcharts-for-python-demos
-Collection of demo visualizations using the Highcharts for Python toolkit
+# Highcharts for Python Demos
+This is a collection of demonstrations of the Highcharts for Python toolkit.
+Fundamentally, they are a Python port of the fantastic demos that Highsoft has
+already published for their 
+[Highcharts JavaScript library](https://www.highcharts.com/demo).
+
+## How to Use the Demos
+First, clone this Github repo:
+
+```
+$ git clone [email protected]:highcharts-for-python/highcharts-for-python-demos.git
+```
+
+Next, navigate to its directory:
+
+```
+$ cd highcharts-for-python-demos
+
+highcharts-for-python-demos/ (master)
+$
+````
+
+Create a virtual environment:
+
+```
+highcharts-for-python-demos/ (master)
+$ python -m venv .venv
+```
+
+Then activate your virtual environment:
+
+```
+highcharts-for-python-demos/ (master)
+$ source .venv/Scripts/activate
+
+(.venv)
+highcharts-for-python-demos/ (master)
+$
+```
+
+and install the requirements:
+
+```
+(.venv)
+highcharts-for-python-demos/ (master)
+$ pip install -r requirements.txt
+```
+
+And finally, open up Jupyter Lab:
+
+```
+(.venv)
+highcharts-for-python-demos/ (master)
+$ jupyter-lab
+```
+
+You should now see the set of notebooks included in the repo, along with relevant data files and other details. Browse through the repo, and look at the demos that you want to see. It should be fairly self-explanatory!

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)