DOC: make shared includes for describing the datasets in the Getting Started tutorials (#38735)

afeld · web-flow · commit f44f3ec3d8eb · 2020-12-30T08:55:25.000-05:00
diff --git a/doc/source/getting_started/intro_tutorials/02_read_write.rst b/doc/source/getting_started/intro_tutorials/02_read_write.rst
@@ -16,38 +16,13 @@
         </div>
         <ul class="list-group list-group-flush">
             <li class="list-group-item">
-                <div data-toggle="collapse" href="#collapsedata" role="button" aria-expanded="false" aria-controls="collapsedata">
-                    <span class="badge badge-dark">Titanic data</span>
-                </div>
-                <div class="collapse" id="collapsedata">
-                    <div class="card-body">
-                        <p class="card-text">
-
-This tutorial uses the Titanic data set, stored as CSV. The data
-consists of the following data columns:
-
--  PassengerId: Id of every passenger.
--  Survived: This feature have value 0 and 1. 0 for not survived and 1
-   for survived.
--  Pclass: There are 3 classes: Class 1, Class 2 and Class 3.
--  Name: Name of passenger.
--  Sex: Gender of passenger.
--  Age: Age of passenger.
--  SibSp: Indication that passenger have siblings and spouse.
--  Parch: Whether a passenger is alone or have family.
--  Ticket: Ticket number of passenger.
--  Fare: Indicating the fare.
--  Cabin: The cabin of passenger.
--  Embarked: The embarked category.
+
+.. include:: titanic.rst
 
 .. raw:: html
 
-                        </p>
-                    <a href="https://github.com/pandas-dev/pandas/tree/master/doc/data/titanic.csv" class="btn btn-dark btn-sm">To raw data</a>
-                </div>
-            </div>
-        </li>
-    </ul>
+            </li>
+        </ul>
     </div>
 
 How do I read and write tabular data?
diff --git a/doc/source/getting_started/intro_tutorials/03_subset_data.rst b/doc/source/getting_started/intro_tutorials/03_subset_data.rst
@@ -16,36 +16,8 @@
         </div>
         <ul class="list-group list-group-flush">
             <li class="list-group-item">
-                <div data-toggle="collapse" href="#collapsedata" role="button" aria-expanded="false" aria-controls="collapsedata">
-                    <span class="badge badge-dark">Titanic data</span>
-                </div>
-                <div class="collapse" id="collapsedata">
-                    <div class="card-body">
-                        <p class="card-text">
-
-This tutorial uses the Titanic data set, stored as CSV. The data
-consists of the following data columns:
-
--  PassengerId: Id of every passenger.
--  Survived: This feature has value 0 and 1. 0 for not survived and 1
-   for survived.
--  Pclass: There are 3 classes: Class 1, Class 2 and Class 3.
--  Name: Name of passenger.
--  Sex: Gender of passenger.
--  Age: Age of passenger.
--  SibSp: Indication that passengers have siblings and spouses.
--  Parch: Whether a passenger is alone or has a family.
--  Ticket: Ticket number of passenger.
--  Fare: Indicating the fare.
--  Cabin: The cabin of passenger.
--  Embarked: The embarked category.
 
-.. raw:: html
-
-                        </p>
-                    <a href="https://github.com/pandas-dev/pandas/tree/master/doc/data/titanic.csv" class="btn btn-dark btn-sm">To raw data</a>
-                </div>
-            </div>
+.. include:: titanic.rst
 
 .. ipython:: python
 
@@ -54,8 +26,8 @@ consists of the following data columns:
 
 .. raw:: html
 
-        </li>
-    </ul>
+            </li>
+        </ul>
     </div>
 
 How do I select a subset of a ``DataFrame``?
diff --git a/doc/source/getting_started/intro_tutorials/04_plotting.rst b/doc/source/getting_started/intro_tutorials/04_plotting.rst
@@ -17,26 +17,8 @@
         </div>
         <ul class="list-group list-group-flush">
             <li class="list-group-item">
-                <div data-toggle="collapse" href="#collapsedata" role="button" aria-expanded="false" aria-controls="collapsedata">
-                    <span class="badge badge-dark">Air quality data</span>
-                </div>
-                <div class="collapse" id="collapsedata">
-                    <div class="card-body">
-                        <p class="card-text">
 
-For this tutorial, air quality data about :math:`NO_2` is used, made
-available by `openaq <https://openaq.org>`__ and using the
-`py-openaq <http://dhhagan.github.io/py-openaq/index.html>`__ package.
-The ``air_quality_no2.csv`` data set provides :math:`NO_2` values for
-the measurement stations *FR04014*, *BETR801* and *London Westminster*
-in respectively Paris, Antwerp and London.
-
-.. raw:: html
-
-                        </p>
-                    <a href="https://github.com/pandas-dev/pandas/tree/master/doc/data/air_quality_no2.csv" class="btn btn-dark btn-sm">To raw data</a>
-                </div>
-            </div>
+. include:: air_quality_no2.rst
 
 .. ipython:: python
 
diff --git a/doc/source/getting_started/intro_tutorials/05_add_columns.rst b/doc/source/getting_started/intro_tutorials/05_add_columns.rst
@@ -16,26 +16,8 @@
         </div>
         <ul class="list-group list-group-flush">
             <li class="list-group-item">
-                <div data-toggle="collapse" href="#collapsedata" role="button" aria-expanded="false" aria-controls="collapsedata">
-                    <span class="badge badge-dark">Air quality data</span>
-                </div>
-                <div class="collapse" id="collapsedata">
-                    <div class="card-body">
-                        <p class="card-text">
-
-For this tutorial, air quality data about :math:`NO_2` is used, made
-available by `openaq <https://openaq.org>`__ and using the
-`py-openaq <http://dhhagan.github.io/py-openaq/index.html>`__ package.
-The ``air_quality_no2.csv`` data set provides :math:`NO_2` values for
-the measurement stations *FR04014*, *BETR801* and *London Westminster*
-in respectively Paris, Antwerp and London.
 
-.. raw:: html
-
-                        </p>
-                    <a href="https://github.com/pandas-dev/pandas/tree/master/doc/data/air_quality_no2.csv" class="btn btn-dark btn-sm">To raw data</a>
-                </div>
-            </div>
+. include:: air_quality_no2.rst
 
 .. ipython:: python
 
diff --git a/doc/source/getting_started/intro_tutorials/06_calculate_statistics.rst b/doc/source/getting_started/intro_tutorials/06_calculate_statistics.rst
@@ -16,36 +16,8 @@
         </div>
         <ul class="list-group list-group-flush">
             <li class="list-group-item">
-                <div data-toggle="collapse" href="#collapsedata" role="button" aria-expanded="false" aria-controls="collapsedata">
-                    <span class="badge badge-dark">Titanic data</span>
-                </div>
-                <div class="collapse" id="collapsedata">
-                    <div class="card-body">
-                        <p class="card-text">
-
-This tutorial uses the Titanic data set, stored as CSV. The data
-consists of the following data columns:
-
--  PassengerId: Id of every passenger.
--  Survived: This feature have value 0 and 1. 0 for not survived and 1
-   for survived.
--  Pclass: There are 3 classes: Class 1, Class 2 and Class 3.
--  Name: Name of passenger.
--  Sex: Gender of passenger.
--  Age: Age of passenger.
--  SibSp: Indication that passenger have siblings and spouse.
--  Parch: Whether a passenger is alone or have family.
--  Ticket: Ticket number of passenger.
--  Fare: Indicating the fare.
--  Cabin: The cabin of passenger.
--  Embarked: The embarked category.
 
-.. raw:: html
-
-                        </p>
-                    <a href="https://github.com/pandas-dev/pandas/tree/master/doc/data/titanic.csv" class="btn btn-dark btn-sm">To raw data</a>
-                </div>
-            </div>
+.. include:: titanic.rst
 
 .. ipython:: python
 
@@ -54,8 +26,8 @@ consists of the following data columns:
 
 .. raw:: html
 
-        </li>
-    </ul>
+            </li>
+        </ul>
     </div>
 
 How to calculate summary statistics?
diff --git a/doc/source/getting_started/intro_tutorials/07_reshape_table_layout.rst b/doc/source/getting_started/intro_tutorials/07_reshape_table_layout.rst
@@ -16,36 +16,8 @@
         </div>
         <ul class="list-group list-group-flush">
             <li class="list-group-item">
-                <div data-toggle="collapse" href="#collapsedata" role="button" aria-expanded="false" aria-controls="collapsedata">
-                    <span class="badge badge-dark">Titanic data</span>
-                </div>
-                <div class="collapse" id="collapsedata">
-                    <div class="card-body">
-                        <p class="card-text">
-
-This tutorial uses the Titanic data set, stored as CSV. The data
-consists of the following data columns:
-
--  PassengerId: Id of every passenger.
--  Survived: This feature have value 0 and 1. 0 for not survived and 1
-   for survived.
--  Pclass: There are 3 classes: Class 1, Class 2 and Class 3.
--  Name: Name of passenger.
--  Sex: Gender of passenger.
--  Age: Age of passenger.
--  SibSp: Indication that passenger have siblings and spouse.
--  Parch: Whether a passenger is alone or have family.
--  Ticket: Ticket number of passenger.
--  Fare: Indicating the fare.
--  Cabin: The cabin of passenger.
--  Embarked: The embarked category.
 
-.. raw:: html
-
-                        </p>
-                    <a href="https://github.com/pandas-dev/pandas/tree/master/doc/data/titanic.csv" class="btn btn-dark btn-sm">To raw data</a>
-                </div>
-            </div>
+.. include:: titanic.rst
 
 .. ipython:: python
 
@@ -108,8 +80,8 @@ measurement.
 
 .. raw:: html
 
-        </li>
-    </ul>
+            </li>
+        </ul>
     </div>
 
 How to reshape the layout of tables?
diff --git a/doc/source/getting_started/intro_tutorials/10_text_data.rst b/doc/source/getting_started/intro_tutorials/10_text_data.rst
@@ -16,36 +16,7 @@
         </div>
         <ul class="list-group list-group-flush">
             <li class="list-group-item">
-                <div data-toggle="collapse" href="#collapsedata" role="button" aria-expanded="false" aria-controls="collapsedata">
-                    <span class="badge badge-dark">Titanic data</span>
-                </div>
-                <div class="collapse" id="collapsedata">
-                    <div class="card-body">
-                        <p class="card-text">
-
-This tutorial uses the Titanic data set, stored as CSV. The data
-consists of the following data columns:
-
--  PassengerId: Id of every passenger.
--  Survived: This feature have value 0 and 1. 0 for not survived and 1
-   for survived.
--  Pclass: There are 3 classes: Class 1, Class 2 and Class 3.
--  Name: Name of passenger.
--  Sex: Gender of passenger.
--  Age: Age of passenger.
--  SibSp: Indication that passenger have siblings and spouse.
--  Parch: Whether a passenger is alone or have family.
--  Ticket: Ticket number of passenger.
--  Fare: Indicating the fare.
--  Cabin: The cabin of passenger.
--  Embarked: The embarked category.
-
-.. raw:: html
-
-                        </p>
-                    <a href="https://github.com/pandas-dev/pandas/tree/master/doc/data/titanic.csv" class="btn btn-dark btn-sm">To raw data</a>
-                </div>
-            </div>
+.. include:: titanic.rst
 
 .. ipython:: python
 
@@ -54,8 +25,8 @@ consists of the following data columns:
 
 .. raw:: html
 
-        </li>
-    </ul>
+            </li>
+        </ul>
     </div>
 
 How to manipulate textual data?
diff --git a/doc/source/getting_started/intro_tutorials/air_quality_no2.rst b/doc/source/getting_started/intro_tutorials/air_quality_no2.rst
@@ -0,0 +1,24 @@
+:orphan:
+
+.. raw:: html
+
+    <div data-toggle="collapse" href="#collapsedata" role="button" aria-expanded="false" aria-controls="collapsedata">
+        <span class="badge badge-dark">Air quality data</span>
+    </div>
+    <div class="collapse" id="collapsedata">
+        <div class="card-body">
+            <p class="card-text">
+
+For this tutorial, air quality data about :math:`NO_2` is used, made
+available by `openaq <https://openaq.org>`__ and using the
+`py-openaq <http://dhhagan.github.io/py-openaq/index.html>`__ package.
+The ``air_quality_no2.csv`` data set provides :math:`NO_2` values for
+the measurement stations *FR04014*, *BETR801* and *London Westminster*
+in respectively Paris, Antwerp and London.
+
+.. raw:: html
+
+            </p>
+            <a href="https://github.com/pandas-dev/pandas/tree/master/doc/data/air_quality_no2.csv" class="btn btn-dark btn-sm">To raw data</a>
+        </div>
+    </div>
diff --git a/doc/source/getting_started/intro_tutorials/titanic.rst b/doc/source/getting_started/intro_tutorials/titanic.rst
@@ -0,0 +1,34 @@
+:orphan:
+
+.. raw:: html
+
+    <div data-toggle="collapse" href="#collapsedata" role="button" aria-expanded="false" aria-controls="collapsedata">
+        <span class="badge badge-dark">Titanic data</span>
+    </div>
+    <div class="collapse" id="collapsedata">
+        <div class="card-body">
+            <p class="card-text">
+
+This tutorial uses the Titanic data set, stored as CSV. The data
+consists of the following data columns:
+
+-  PassengerId: Id of every passenger.
+-  Survived: This feature have value 0 and 1. 0 for not survived and 1
+   for survived.
+-  Pclass: There are 3 classes: Class 1, Class 2 and Class 3.
+-  Name: Name of passenger.
+-  Sex: Gender of passenger.
+-  Age: Age of passenger.
+-  SibSp: Indication that passenger have siblings and spouse.
+-  Parch: Whether a passenger is alone or have family.
+-  Ticket: Ticket number of passenger.
+-  Fare: Indicating the fare.
+-  Cabin: The cabin of passenger.
+-  Embarked: The embarked category.
+
+.. raw:: html
+
+            </p>
+            <a href="https://github.com/pandas-dev/pandas/tree/master/doc/data/titanic.csv" class="btn btn-dark btn-sm">To raw data</a>
+        </div>
+    </div>
