Convert relational model API examples to use notebooks (#2201)

* Update scatterplot API docs to use notebook * Convert lineplot API examples to notebook * Convert relplot API examples to use notebook * Improve notebook processing, don't remove html output * Start improving lineplot API examples * Improve (?) lineplot API examples * Improve scatterplot API examples * Hide import cells in distribution plot API examples * Demo using FacetGrid in relplot docs * Fix doc bugs [ci skip]
mwaskom · Aug 18, 2020 · d6e94a6 · d6e94a6
1 parent bccfb29
commit d6e94a6
Show file tree

Hide file tree

Showing 10 changed files with 1,064 additions and 395 deletions.
diff --git a/doc/_static/style.css b/doc/_static/style.css
@@ -26,6 +26,7 @@ blockquote {
 }
 
 pre {
+    margin-top: 11.5px !important;
     background-color: #f6f6f9 !important;
 }
 

diff --git a/doc/docstrings/displot.ipynb b/doc/docstrings/displot.ipynb
@@ -1,7 +1,20 @@
 {
  "cells": [
   {
-   "cell_type": "markdown",
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": [
+     "hide"
+    ]
+   },
+   "outputs": [],
+   "source": [
+    "import seaborn as sns; sns.set(style=\"ticks\")"
+   ]
+  },
+  {
+   "cell_type": "raw",
    "metadata": {},
    "source": [
     "The default plot kind is a histogram:"
@@ -13,13 +26,12 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "import seaborn as sns; sns.set(style=\"ticks\")\n",
     "penguins = sns.load_dataset(\"penguins\")\n",
     "sns.displot(data=penguins, x=\"flipper_length_mm\")"
    ]
   },
   {
-   "cell_type": "markdown",
+   "cell_type": "raw",
    "metadata": {},
    "source": [
     "Use the ``kind`` parameter to select a different representation:"
@@ -115,7 +127,7 @@
    ]
   },
   {
-   "cell_type": "markdown",
+   "cell_type": "raw",
    "metadata": {},
    "source": [
     "Each kind of plot can be drawn separately for subsets of data using ``hue`` mapping:"
@@ -201,13 +213,6 @@
     "g.set_axis_labels(\"Density (a.u.)\", \"Flipper length (mm)\")\n",
     "g.set_titles(\"{col_name} penguins\")"
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": null,
-   "metadata": {},
-   "outputs": [],
-   "source": []
   }
  ],
  "metadata": {

diff --git a/doc/docstrings/ecdfplot.ipynb b/doc/docstrings/ecdfplot.ipynb
@@ -7,13 +7,25 @@
     "Plot a univariate distribution along the x axis:"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": [
+     "hide"
+    ]
+   },
+   "outputs": [],
+   "source": [
+    "import seaborn as sns; sns.set()"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,
    "metadata": {},
    "outputs": [],
    "source": [
-    "import seaborn as sns; sns.set()\n",
     "penguins = sns.load_dataset(\"penguins\")\n",
     "sns.ecdfplot(data=penguins, x=\"flipper_length_mm\")"
    ]

diff --git a/doc/docstrings/histplot.ipynb b/doc/docstrings/histplot.ipynb
@@ -1,10 +1,24 @@
 {
  "cells": [
   {
-   "cell_type": "markdown",
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": [
+     "hide"
+    ]
+   },
+   "outputs": [],
+   "source": [
+    "import seaborn as sns\n",
+    "sns.set(style=\"white\")"
+   ]
+  },
+  {
+   "cell_type": "raw",
    "metadata": {},
    "source": [
-    "Plot a univariate distribution along the x axis:"
+    "Assign a variable to ``x`` to plot a univariate distribution along the x axis:"
    ]
   },
   {
@@ -13,7 +27,6 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "import seaborn as sns; sns.set(style=\"white\")\n",
     "penguins = sns.load_dataset(\"penguins\")\n",
     "sns.histplot(data=penguins, x=\"flipper_length_mm\")"
    ]
@@ -231,10 +244,10 @@
    ]
   },
   {
-   "cell_type": "markdown",
+   "cell_type": "raw",
    "metadata": {},
    "source": [
-    "For heavily skewed distributions, it's better to define the bins in log space. Compare:"
+    "Real-world data is often skewed. For heavily skewed distributions, it's better to define the bins in log space. Compare:"
    ]
   },
   {

diff --git a/doc/docstrings/kdeplot.ipynb b/doc/docstrings/kdeplot.ipynb
@@ -1,5 +1,18 @@
 {
  "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {
+    "tags": [
+     "hide"
+    ]
+   },
+   "outputs": [],
+   "source": [
+    "import seaborn as sns; sns.set()"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -13,7 +26,6 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "import seaborn as sns; sns.set()\n",
     "tips = sns.load_dataset(\"tips\")\n",
     "sns.kdeplot(data=tips, x=\"total_bill\")"
    ]