Merge pull request #71 from TUDelftGeodesy/57_add_documentation

57 add documentation

.gitignore

@@ -156,4 +156,5 @@ dmypy.json
 cython_debug/
 
 # VSCode
-.vscode
+.vscode
+

docs/CONTRIBUTING.md

@@ -42,4 +42,6 @@ to see if someone already filed the same issue;
 - [push](http://rogerdudler.github.io/git-guide/) your feature branch to (your fork of) the stmtools repository on GitHub;
 - create the pull request, e.g. following [the instructions: creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
 
-In case you feel like you've made a valuable contribution, but you don't know how to write or run tests for it, or how to generate the documentation: don't let this discourage you from making the pull request; we can help you! Just go ahead and submit the pull request, but keep in mind that you might be asked to append additional commits to your pull request.
+In case you feel like you've made a valuable contribution, but you don't know how to write or run tests for it, or how to generate the documentation: don't let this discourage you from making the pull request; we can help you! Just go ahead and submit the pull request, but keep in mind that you might be asked to append additional commits to your pull request.
+
+In case you want to add documentation and you don't have mkdocs installed in your root environment, you can install it by calling ```pip install -e .[docs]```. You can then test your documentation by calling ```mkdocs serve```.

docs/notebooks/demo_stm.ipynb → docs/notebooks/demo_operations_stm.ipynb

@@ -5,7 +5,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Example Notebook\n",
+    "# Example Operations\n",
     "\n",
     "In this example notebook, we will demonstrate how to:\n",
     "\n",
@@ -102,7 +102,7 @@
    "source": [
     "path_stm = Path('./stm.zarr')\n",
     "stmat = xr.open_zarr(path_stm)\n",
-    "stmat = stmat.chunk({\"space\": 10000, \"time\":-1}) # Chunk 10000 space, no chunk in time\n",
+    "stmat = stmat.chunk({\"space\": 10000, \"time\": -1}) # Chunk 10000 space, no chunk in time\n",
     "\n",
     "print(stmat)"
    ]