Update docs (#91)

* Update docs * Add notebook links * Update Iris example
domvwt · Feb 24, 2022 · be5b5a0 · be5b5a0
1 parent 245b1e5
commit be5b5a0
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 20 deletions.
diff --git a/README.md b/README.md
@@ -111,7 +111,7 @@ Examples
 --------
 
 Iris Report - [Webpage](https://domvwt.github.io/esparto/examples/iris-report.html) |
-[PDF](https://domvwt.github.io/esparto/examples/iris-report.pdf)
+[PDF](https://domvwt.github.io/esparto/examples/iris-report.pdf) | [Notebook](https://github.com/domvwt/esparto/blob/main/docs/examples/iris-report.ipynb)
 
 <br>
 

diff --git a/docs/02-user-guide/quick-start.md b/docs/02-user-guide/quick-start.md
@@ -75,7 +75,6 @@ del page.section_title.row_title[-1]
 
 ```python
 del page.section_title.row_title.column_two
-page.tree()
 ```
 
 ```

diff --git a/docs/02-user-guide/tutorial-notebooks.md b/docs/02-user-guide/tutorial-notebooks.md
@@ -2,17 +2,18 @@
 
 ## Data Analysis
 
-[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/domvwt/esparto/blob/main/docs/examples/iris-report.ipynb)
-[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/domvwt/esparto/main?filepath=docs%2Fexamples%2Firis-report.ipynb)
-[![GitHub](https://img.shields.io/badge/view%20on-GitHub-lightgrey)](https://github.com/domvwt/esparto/blob/main/docs/examples/iris-report.ipynb)
+The Iris dataset is one of the best known datasets in statistics.
+In this example we put together a simple data analysis report using:
 
-This notebook shows how we can put together a simple data analysis report.
+* Text content with markdown formatting
+* Pandas DataFrames
+* Plots from Matplotlib
 
-* Text content with Markdown formatting
-* Converting a Pandas DataFrame to a table
-* Adding plots from Matplotlib
+[Webpage](../examples/iris-report.html) | [PDF](../examples/iris-report.pdf)
 
-Output: [Webpage](../examples/iris-report.html) | [PDF](../examples/iris-report.pdf)
+[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/domvwt/esparto/blob/main/docs/examples/iris-report.ipynb)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/domvwt/esparto/main?filepath=docs%2Fexamples%2Firis-report.ipynb)
+[![GitHub](https://img.shields.io/badge/view%20on-GitHub-lightgrey)](https://github.com/domvwt/esparto/blob/main/docs/examples/iris-report.ipynb)
 
 ----
 

diff --git a/docs/examples/iris-report.ipynb b/docs/examples/iris-report.ipynb
-Original file line number
+Diff line change
@@ Expand Up / @@ -111,7 +111,7 @@ Examples @@
     --------
     Iris Report - [Webpage](https://domvwt.github.io/esparto/examples/iris-report.html) |
-    [PDF](https://domvwt.github.io/esparto/examples/iris-report.pdf)
+    [PDF](https://domvwt.github.io/esparto/examples/iris-report.pdf) | [Notebook](https://github.com/domvwt/esparto/blob/main/docs/examples/iris-report.ipynb)
     <br>
@@ Expand Down @@