improved documentation

Author: Davide-sd

doc/source/changelog.rst

@@ -2,6 +2,15 @@
  Changelog
 ==========
 
+
+v2.0.1
+======
+
+* Bug fix: included static files necessary for serving interactive application
+  on a new browser window.
+* Improved documentation.
+
+
 v2.0.1
 ======
 

doc/source/install.rst

@@ -5,45 +5,48 @@ Installation
 ------------
 
 SymPy Plotting Backends can be installed with `pip` or `conda`. By default,
-only basic plotting with Matplotlib will be installed::
+only basic plotting with Numpy and Matplotlib will be installed::
 
     pip install sympy_plot_backends
 
 Or::
 
     conda install -c conda-forge sympy_plot_backends 
 
-To install the complete requirements in order to get interactive plots, bokeh,
-plotly, k3d, vtk, execute the following command::
+To install the complete requirements in order to get adaptive algorithm,
+interactive plots, bokeh, plotly, k3d, vtk, execute the following command::
 
     pip install sympy_plot_backends[all]
 
-Or::
+If you are using zshell, the above `pip` command is going to fail.
+Use the following instead::
+
+    pip install "sympy_plot_backends[all]"
 
-    # optional: colorcet gives more colormaps, scipy gives more numerical
-    # functions, notebook install the Jupyter Notebook (enabling interactivity)
-    conda install -c anaconda scipy notebook colorcet
-    # optional: to install the adaptive algorithm:
+To install the complete requirements with conda::
+
+    # scipy gives more numerical functions, notebook install the
+    # Jupyter Notebook (enabling interactivity)
+    conda install -c anaconda scipy notebook
+    # to install the adaptive algorithm:
     conda install -c conda-forge adaptive
-    # optional: to install interactive widgets with holoviz's Panel
+    # to install interactive widgets with holoviz's Panel
     conda install -c conda-forge panel
-    # optional: to install interactive widgets with ipywidgets
+    # to install interactive widgets with ipywidgets
     conda install -c anaconda ipywidgets
     conda install -c conda-forge ipympl
     conda install -c bokeh ipywidgets_bokeh
-    # optional: to install K3D-Jupyter
+    # colorcet gives more colormaps
+    conda install -c conda-forge colorcet
+    # to install K3D-Jupyter
     conda install -c conda-forge k3d msgpack-python
-    # optional: to install Plotly
+    # to install Plotly
     conda install -c plotly plotly
-    # optional: to enable 3D streamlines plots with matplotlib and K3D-Jupyter
+    # to enable 3D streamlines plots with matplotlib and K3D-Jupyter
     conda install -c conda-forge vtk
-    # required: to install the basic plotting module with Matplotlib
+    # finally
     conda install -c conda-forge sympy_plot_backends
 
-Finally, if you are using zshell, the above `pip` command is going to fail.
-Use the following instead::
-
-    pip install "sympy_plot_backends[all]"
 
 
 Verify the installation
@@ -111,8 +114,9 @@ It is also the perfect time to verify that K3D-Jupyter is working:
    4. Restart ``jupyter notebook``
    5. Open the previous notebook and execute the plot command.
 
-Refer to the :ref:`tutorials` for a starter guide on using the plotting backends or to the :ref:`functions` to visualize the output of some of the
-plotting functions.
+Refer :ref:`functions` to explore visualize the output of some of the
+plotting functions, or to the :ref:`tutorials` for a starter guide on using
+the plotting backends.
 
 
 Installing Mayavi

doc/source/tutorials/index.rst

@@ -4,24 +4,6 @@
  Tutorials
 ==========
 
-Several Jupyter Notebook tutorials are available in the
-`Github repository <https://github.com/Davide-sd/sympy-plot-backends/tree/master/tutorials>`_.
-They are designed to illustrate the differences between the backends.
-
-Sadly, given the high number of JS-based figures, it would be unwise to
-include them into this documentation page, as the loading of the page would
-become excessively slow.
-
-Hence, you can visit the aforementioned repository and:
-
-* download and run them locally (preferred option).
-* or you can launch Binder and try them online (note that Binder is really
-  slow).
-
-If you are in a hurry, the following quickstart should provide a good
-starting point. However, ``iplot``-related tutorials are only
-available at the aforementioned repository.
-
 .. toctree::
    :maxdepth: 1
    :caption: Quickstart
@@ -32,4 +14,3 @@ available at the aforementioned repository.
    tut-3.rst
    tut-4.rst
    tut-5.rst
-   tut-6.rst