Merge pull request #71 from martinRenou/doc

Update documentation

Author: martinRenou

README.md

@@ -6,7 +6,7 @@
 [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/martinRenou/ipycanvas/stable?filepath=examples)
 [![Build Status](https://travis-ci.org/martinRenou/ipycanvas.svg?branch=master)](https://travis-ci.org/martinRenou/ipycanvas)
 
-ipycanvas is a lightweight, fast and stable library exposing the [browser's Canvas API](https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API) to Python.
+ipycanvas is a lightweight, fast and stable library exposing the [browser's Canvas API](https://developer.mozilla.org/en-US/docs/Web/API/Canvas_API) to IPython.
 It allows you to draw simple primitives directly from Python like text, lines, polygons, arcs, images etc. This simple toolset allows you to draw literally anything!
 
 ## Try it online!
@@ -17,7 +17,7 @@ You can try it online by clicking on this badge:
 
 ## Documentation
 
-You can read the documentation following this link: https://ipycanvas.readthedocs.io/en/latest/
+You can read the documentation following this link: https://ipycanvas.readthedocs.io
 
 ## Examples
 
@@ -53,35 +53,6 @@ conda install -c conda-forge ipycanvas
 And if you use jupyterlab:
 
 ```bash
+conda install -c conda-forge nodejs
 jupyter labextension install @jupyter-widgets/jupyterlab-manager ipycanvas
 ```
-
-If you are using Jupyter Notebook 5.2 or earlier, you may also need to enable
-the nbextension:
-```bash
-jupyter nbextension enable --py [--sys-prefix|--user|--system] ipycanvas
-```
-
-## Installation from sources
-
-You can install using `pip`:
-
-```bash
-git clone https://github.com/martinRenou/ipycanvas
-cd ipycanvas
-pip install .
-```
-
-And if you use jupyterlab:
-
-```bash
-jupyter labextension install @jupyter-widgets/jupyterlab-manager
-jupyter labextension install .
-```
-
-And you use the classical Jupyter:
-
-```bash
-jupyter nbextension install --py --symlink --sys-prefix ipycanvas
-jupyter nbextension enable --py --sys-prefix ipycanvas
-```

docs/source/conf.py

@@ -2,17 +2,13 @@
 import sphinx_rtd_theme
 
 extensions = [
+    'sphinx_rtd_theme',
     'sphinx.ext.autodoc',
-    'sphinx.ext.napoleon',
-    # 'sphinx.ext.intersphinx',
-    # 'sphinx.ext.autosummary',
-    # 'sphinx.ext.viewcode',
-    # 'jupyter_sphinx.embed_widgets',
+    'sphinx.ext.napoleon'
 ]
 
 templates_path = ['_templates']
 
-
 master_doc = 'index'
 source_suffix = '.rst'
 
@@ -25,8 +21,13 @@
 pygments_style = 'sphinx'
 
 # Output file base name for HTML help builder.
+html_logo = "./images/ipycanvas_logo.svg"
 html_theme = "sphinx_rtd_theme"
 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
 htmlhelp_basename = 'ipycanvasdoc'
 
+html_theme_options = dict(
+    style_nav_header_background='#0d6a0a'
+)
+
 autodoc_member_order = 'bysource'

docs/source/installation.rst

@@ -6,7 +6,6 @@ Using pip
 .. code:: bash
 
     pip install ipycanvas
-    jupyter nbextension enable --py --sys-prefix ipycanvas  # can be skipped for notebook 5.3 and above
 
 Using conda
 ===========
@@ -18,7 +17,14 @@ Using conda
 JupyterLab extension
 ====================
 
-If you have JupyterLab, you will also need to install the JupyterLab extension:
+If you have JupyterLab, you will also need to install the JupyterLab extension. In order to install the JupyterLab extension,
+you will need ``npm`` to be installed. You can easily install ``npm`` with conda:
+
+.. code:: bash
+
+    conda install -c conda-forge nodejs
+
+Then you can install the JupyterLab extension:
 
 .. code:: bash
 
@@ -34,6 +40,10 @@ For a development installation (requires npm):
     git clone https://github.com/martinRenou/ipycanvas.git
     cd ipycanvas
     pip install -e .
+
+    # If you are developing on the classic Jupyter Notebook
     jupyter nbextension install --py --symlink --sys-prefix ipycanvas
     jupyter nbextension enable --py --sys-prefix ipycanvas
-    jupyter labextension install @jupyter-widgets/jupyterlab-manager .  # If you are developing on JupyterLab
+
+    # If you are developing on JupyterLab
+    jupyter labextension install @jupyter-widgets/jupyterlab-manager .