From 4aac76c624fb6160cd2dd930f2fd7f5b119efd8a Mon Sep 17 00:00:00 2001
From: Aidan Feldman <aidan.feldman@gmail.com>
Date: Wed, 30 Dec 2020 19:05:57 -0500
Subject: [PATCH] DOC: fix includes

- Added missing `.` to the `.. include`s
- Put the includes in a folder to exclude from Sphinx, to avoid
  `:orphan:` being written to the HTML
---
 doc/source/conf.py                                         | 7 ++++++-
 .../getting_started/intro_tutorials/02_read_write.rst      | 2 +-
 .../getting_started/intro_tutorials/03_subset_data.rst     | 2 +-
 doc/source/getting_started/intro_tutorials/04_plotting.rst | 2 +-
 .../getting_started/intro_tutorials/05_add_columns.rst     | 2 +-
 .../intro_tutorials/06_calculate_statistics.rst            | 2 +-
 .../intro_tutorials/07_reshape_table_layout.rst            | 2 +-
 .../getting_started/intro_tutorials/10_text_data.rst       | 2 +-
 .../intro_tutorials/{ => includes}/air_quality_no2.rst     | 2 --
 .../intro_tutorials/{ => includes}/titanic.rst             | 2 --
 10 files changed, 13 insertions(+), 12 deletions(-)
 rename doc/source/getting_started/intro_tutorials/{ => includes}/air_quality_no2.rst (98%)
 rename doc/source/getting_started/intro_tutorials/{ => includes}/titanic.rst (99%)

diff --git a/doc/source/conf.py b/doc/source/conf.py
index 951a6d4043786..7f7309bae7031 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -68,7 +68,12 @@
     "contributors",  # custom pandas extension
 ]
 
-exclude_patterns = ["**.ipynb_checkpoints"]
+exclude_patterns = [
+    "**.ipynb_checkpoints",
+    # to ensure that include files (partial pages) aren't built, exclude them
+    # https://github.com/sphinx-doc/sphinx/issues/1965#issuecomment-124732907
+    "**/includes/**",
+]
 try:
     import nbconvert
 except ImportError:
diff --git a/doc/source/getting_started/intro_tutorials/02_read_write.rst b/doc/source/getting_started/intro_tutorials/02_read_write.rst
index 3457ed142510b..d69a48def0287 100644
--- a/doc/source/getting_started/intro_tutorials/02_read_write.rst
+++ b/doc/source/getting_started/intro_tutorials/02_read_write.rst
@@ -17,7 +17,7 @@
         <ul class="list-group list-group-flush">
             <li class="list-group-item">
 
-.. include:: titanic.rst
+.. include:: includes/titanic.rst
 
 .. raw:: html
 
diff --git a/doc/source/getting_started/intro_tutorials/03_subset_data.rst b/doc/source/getting_started/intro_tutorials/03_subset_data.rst
index 083e4f9d8373e..fe3eae6c42959 100644
--- a/doc/source/getting_started/intro_tutorials/03_subset_data.rst
+++ b/doc/source/getting_started/intro_tutorials/03_subset_data.rst
@@ -17,7 +17,7 @@
         <ul class="list-group list-group-flush">
             <li class="list-group-item">
 
-.. include:: titanic.rst
+.. include:: includes/titanic.rst
 
 .. ipython:: python
 
diff --git a/doc/source/getting_started/intro_tutorials/04_plotting.rst b/doc/source/getting_started/intro_tutorials/04_plotting.rst
index ef0e5592f6f93..615b944fd395f 100644
--- a/doc/source/getting_started/intro_tutorials/04_plotting.rst
+++ b/doc/source/getting_started/intro_tutorials/04_plotting.rst
@@ -18,7 +18,7 @@
         <ul class="list-group list-group-flush">
             <li class="list-group-item">
 
-. include:: air_quality_no2.rst
+.. include:: includes/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
index fc7dfc7dcc29d..dc18be935b973 100644
--- a/doc/source/getting_started/intro_tutorials/05_add_columns.rst
+++ b/doc/source/getting_started/intro_tutorials/05_add_columns.rst
@@ -17,7 +17,7 @@
         <ul class="list-group list-group-flush">
             <li class="list-group-item">
 
-. include:: air_quality_no2.rst
+.. include:: includes/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
index 2420544c28bef..fcf754e340ab2 100644
--- a/doc/source/getting_started/intro_tutorials/06_calculate_statistics.rst
+++ b/doc/source/getting_started/intro_tutorials/06_calculate_statistics.rst
@@ -17,7 +17,7 @@
         <ul class="list-group list-group-flush">
             <li class="list-group-item">
 
-.. include:: titanic.rst
+.. include:: includes/titanic.rst
 
 .. ipython:: python
 
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
index 0f550cbeb2154..bd4a617fe753b 100644
--- a/doc/source/getting_started/intro_tutorials/07_reshape_table_layout.rst
+++ b/doc/source/getting_started/intro_tutorials/07_reshape_table_layout.rst
@@ -17,7 +17,7 @@
         <ul class="list-group list-group-flush">
             <li class="list-group-item">
 
-.. include:: titanic.rst
+.. include:: includes/titanic.rst
 
 .. ipython:: python
 
diff --git a/doc/source/getting_started/intro_tutorials/10_text_data.rst b/doc/source/getting_started/intro_tutorials/10_text_data.rst
index 2df8b1cb29770..63db920164ac3 100644
--- a/doc/source/getting_started/intro_tutorials/10_text_data.rst
+++ b/doc/source/getting_started/intro_tutorials/10_text_data.rst
@@ -16,7 +16,7 @@
         </div>
         <ul class="list-group list-group-flush">
             <li class="list-group-item">
-.. include:: titanic.rst
+.. include:: includes/titanic.rst
 
 .. ipython:: python
 
diff --git a/doc/source/getting_started/intro_tutorials/air_quality_no2.rst b/doc/source/getting_started/intro_tutorials/includes/air_quality_no2.rst
similarity index 98%
rename from doc/source/getting_started/intro_tutorials/air_quality_no2.rst
rename to doc/source/getting_started/intro_tutorials/includes/air_quality_no2.rst
index 7515e004a4177..a5a5442330e43 100644
--- a/doc/source/getting_started/intro_tutorials/air_quality_no2.rst
+++ b/doc/source/getting_started/intro_tutorials/includes/air_quality_no2.rst
@@ -1,5 +1,3 @@
-:orphan:
-
 .. raw:: html
 
     <div data-toggle="collapse" href="#collapsedata" role="button" aria-expanded="false" aria-controls="collapsedata">
diff --git a/doc/source/getting_started/intro_tutorials/titanic.rst b/doc/source/getting_started/intro_tutorials/includes/titanic.rst
similarity index 99%
rename from doc/source/getting_started/intro_tutorials/titanic.rst
rename to doc/source/getting_started/intro_tutorials/includes/titanic.rst
index e73f18a6f2669..7032b70b3f1cf 100644
--- a/doc/source/getting_started/intro_tutorials/titanic.rst
+++ b/doc/source/getting_started/intro_tutorials/includes/titanic.rst
@@ -1,5 +1,3 @@
-:orphan:
-
 .. raw:: html
 
     <div data-toggle="collapse" href="#collapsedata" role="button" aria-expanded="false" aria-controls="collapsedata">