DOC: fix includes (pandas-dev#38839)

luckyvs1 · Jan 20, 2021 · 380dd95 · 380dd95
1 parent 356a0d8
commit 380dd95
Show file tree

Hide file tree

Showing 10 changed files with 13 additions and 12 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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/...arted/intro_tutorials/air_quality_no2.rst → ...ro_tutorials/includes/air_quality_no2.rst b/...arted/intro_tutorials/air_quality_no2.rst → ...ro_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/...tting_started/intro_tutorials/titanic.rst → ...rted/intro_tutorials/includes/titanic.rst b/...tting_started/intro_tutorials/titanic.rst → ...rted/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">