Added notebooks as examples to the documentation.

README.md

@@ -4,7 +4,7 @@ Contains interactive optimization methods for solving multiobjective optimizaton
 
 ## Installation
 
-Requires [poetry](https://python-poetry.org/). See `pyproject.toml` for Python package requirements. To install and use the this package:
+Requires [poetry](https://python-poetry.org/). See `pyproject.toml` for Python package requirements. To install and use the this package with poetry, issue the following command:
 
 1. `git clone https://github.com/industrial-optimization-group/desdeo-mcdm`
 2. `cd desdeo-mcdm`
@@ -25,12 +25,3 @@ Documentation for this package can be found [here](https://desdeo-mcdm.readthedo
 
 - Pareto Navigator
 - NAUTILUSv2
-
-## Demonstrations
-
-### NAUTILUS Navigator
-
-The implementation of NAUTILUS Navigator has been used to build a web based graphical user interface found [online](https://dash.misitano.xyz). Feel free to try it! The source code for this demo is available [here](https://github.com/gialmisi/desdeo-dash).
-
-Here is a video of the webapp in action:
-![NAUTILUS Navigator in action.](https://github.com/industrial-optimization-group/desdeo-mcdm/blob/master/assets/nautilus_nav_demo.gif "A gif of the demo in action.")

docs/conf.py

@@ -42,6 +42,8 @@
     "sphinx.ext.graphviz",
     "sphinx.ext.viewcode",
     "recommonmark",
+    "nbsphinx",
+    "sphinx.ext.mathjax",
 ]
 numpydoc_show_class_members = False
 
@@ -75,6 +77,7 @@
 # a list of builtin themes.
 #
 html_theme = "sphinx_rtd_theme"
+html_sourcelink_suffix = ""
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

docs/examples.rst

@@ -0,0 +1,9 @@
+Examples
+========
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Available examples:
+
+   notebooks/nautilus_navigator
+   notebooks/synchronous_nimbus

docs/index.rst

@@ -13,6 +13,7 @@ desdeo-mcdm's documentation
    README <README>
    background/index
    api
+   examples