Merge pull request #5 from spatial-model-editor/docs

add installation & source code info to docs
spatial-model-editor · Aug 17, 2021 · 125c992 · 125c992
2 parents e92ecd9 + 7ccd58b
commit 125c992
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 3 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,9 +1,20 @@
-sme_contrib
+sme-contrib
 ===========
 
 A collection of useful modules for use with `sme <https://pypi.org/project/sme/>`_,
 the python interface to `Spatial Model Editor <https://spatial-model-editor.readthedocs.io/>`_.
 
+Installation
+------------
+
+To install from `PyPI <https://pypi.org/project/sme-contrib/>`_:
+
+.. code-block:: bash
+
+    pip install sme-contrib
+
+API Reference
+-------------
 
 .. autosummary::
    :toctree: _autosummary
@@ -14,7 +25,13 @@ the python interface to `Spatial Model Editor <https://spatial-model-editor.read
    sme_contrib.plot
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
    :caption: Example jupyter notebooks
 
    notebooks/plot
+
+Source code
+-----------
+
+The source code is available from `GitHub <https://github.com/spatial-model-editor/sme_contrib>`_.
+and released under a permissive `MIT license <https://github.com/spatial-model-editor/sme_contrib/blob/master/LICENSE>`_.
diff --git a/docs/notebooks/plot.ipynb b/docs/notebooks/plot.ipynb
@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# sme_contrib.plot examples"
+    "# sme_contrib.plot"
    ]
   },
   {