Merge pull request #34 from DenisaCG/documentation

Added examples and docs

Author: wolfv

.eslintignore

@@ -10,6 +10,8 @@ tests
 .github
 binder
 jupyterlab_blockly/labextension
+docs
+examples
 .eslintignore
 .eslintrc.js
 .gitignore

MANIFEST.in

@@ -23,3 +23,16 @@ global-exclude *.pyc
 global-exclude *.pyo
 global-exclude .git
 global-exclude .ipynb_checkpoints
+
+# Documentation
+recursive-include docs *.bat
+recursive-include docs *.gif
+recursive-include docs *.md
+recursive-include docs *.png
+recursive-include docs *.rst
+recursive-include docs *.txt
+recursive-include docs Makefile
+recursive-include docs *.py
+
+# Examples
+recursive-include examples *.jpblockly

README.md

@@ -20,9 +20,7 @@ Repo: https://github.com/google/blockly
 To install the extension, execute:
 
 ```bash
-micromamba create -n blockly -c conda-forge python jupyterlab==3.4 ipykernel xeus-python xeus-lua jupyterlab-language-pack-es-ES jupyterlab-language-pack-fr-FR
-micromamba activate blockly
-pip install jupyterlab_blockly
+conda install -c conda-forge jupyterlab-blockly
 ```
 
 #### Kernels
@@ -38,7 +36,7 @@ pip install jupyterlab_blockly
 To remove the extension, execute:
 
 ```bash
-pip uninstall jupyterlab_blockly
+conda uninstall -c conda-forge jupyterlab-blockly
 ```
 
 ## Contributing

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)