docs: add more notebooks to readthedocs page

README.md

@@ -1,5 +1,7 @@
 <!-- buttons -->
 <p align="center">
+    <a href="http://okama.readthedocs.io/">
+        <img src="https://img.shields.io/readthedocs/okama.svg?style=popout" alt="docs">
     <a href="https://www.python.org/">
         <img src="https://img.shields.io/badge/python-v3-brightgreen.svg"
             alt="python"></a> &nbsp;
@@ -34,6 +36,7 @@ _okama_ goes with **free** «end of day» historical stock markets data and macr
   - [Other historical data](#other-historical-data)
 - [Installation](#installation)
 - [Getting started](#getting-started)
+- [Documentation](#documentation)
 - [RoadMap](#roadmap)
 - [Contributing to okama](#contributing-to-okama)
 - [Communication](#communication)
@@ -157,6 +160,10 @@ map = ok.Plots(ls, ccy='USD').plot_transition_map(cagr=False)
 
 More examples are available in form of [Jupyter Notebooks](https://github.com/mbk-dev/okama/tree/master/examples).
 
+## Documentation
+
+The official documentation is hosted on readthedocs.org: [https://okama.readthedocs.io/](https://okama.readthedocs.io/)
+
 ## RoadMap
 
 The plan for _okama_ is to add more functions that will be useful to investors and asset managers.

docs/conf.py

@@ -50,6 +50,8 @@
 # The encoding of source files.
 source_encoding = "utf-8"
 
+add_module_names = False
+
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.

docs/index.rst

@@ -98,15 +98,23 @@ The latest development version can be installed directly from GitHub:
 
     The development version of *okama* can have technical and financial issues. Please use carefully at your own risk.
 
+.. toctree::
+    :maxdepth: 1
+    :caption: Quick Start
 
-Classes Overview
-****************
+    /jupyter/quickstart
 
 .. toctree::
-    :maxdepth: 0
-    :caption: Quick Start
+    :maxdepth: 1
+    :caption: Index Funds Performance
+
+    /jupyter/funds
+
+.. toctree::
+    :maxdepth: 1
+    :caption: Investment Portfolios
 
-    quickstart
+    /jupyter/portfolio
 
 .. autosummary::
     :toctree: stubs

docs/jupyter/funds.nblink

@@ -0,0 +1,3 @@
+{
+    "path": "../../examples/02 index funds perfomance.ipynb"
+}

docs/jupyter/portfolio.nblink

@@ -0,0 +1,3 @@
+{
+    "path": "../../examples/03 investment portfolios.ipynb"
+}

docs/jupyter/quickstart.nblink

@@ -0,0 +1,3 @@
+{
+    "path": "../../examples/01 howto.ipynb"
+}

examples/01 howto.ipynb

@@ -7,6 +7,20 @@
     "<a href=\"https://colab.research.google.com/github/mbk-dev/okama/blob/master/examples/01%20howto.ipynb\"><img align=\"left\" src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open in Colab\" title=\"Open and Execute in Google Colaboratory\"></a>"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "You can run the code examples in [Google Colab](https://colab.research.google.com/github/mbk-dev/okama/blob/master/examples/01%20howto.ipynb)."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "**To install the package:**"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 1,
@@ -16,6 +30,13 @@
     "!pip install okama"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "import okama and matplotlib packages ..."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 2,

examples/02 index funds perfomance.ipynb

@@ -7,6 +7,20 @@
     "<a href=\"https://colab.research.google.com/github/mbk-dev/okama/blob/master/examples/02%20index%20funds%20perfomance.ipynb\"><img align=\"left\" src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open in Colab\" title=\"Open and Execute in Google Colaboratory\"></a>"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "You can run the code examples in [Google Colab](https://colab.research.google.com/github/mbk-dev/okama/blob/master/examples/02%20index%20funds%20perfomance.ipynb)."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "**To install the package:**"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
@@ -16,6 +30,13 @@
     "!pip install okama"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "import okama and matplotlib packages ..."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 1,