Convert docs to pydata-sphinx-theme and add new material (#2842)

* Do basic conversion of site to pydata_sphinx_theme * Remove some pae structure customizations we no longer need * Add some custom CSS * Tweak a few more colors * Remove vestigial div closing tag * Reorganize release notes into hierarchical pages * Rebuild full docs and fix some resulting issues * Make release note doc refs absolute * Convert homepage to use sphinx-design instead of hand-crafted html * Remove original custom css * Simplify header and put archive switcher in footer * Streamline API docs for objects * Play around with templates to fix shrinking content (not perfect yet) * Improve use of horizontal space without sidebars * Various tweaks * Convert tutorial homepage source to native sphinx-design directives * Move intro page into tutorial * More tweaks * Tweak theme colors and footer * Remove reference to navbar version * Note that error bar tutorial demonstrates new features as of v0.12 * Update layout customization for new theme features * Various layout and CSS tweaks * Narrow support guidance to StackOverflow * Run all notebooks * Adapt to new dropdown navbar in pydata theme * Separate tutorial source and outputs * Separate dostring source and outputs * Add scale API template * Update API docs * Fix requirements * Add new objects * Point doc requirements at v0.10 RC for theme
mwaskom · Jul 25, 2022 · 34662f4 · 34662f4
1 parent fb61ded
commit 34662f4
Show file tree

Hide file tree

Showing 89 changed files with 1,047 additions and 1,374 deletions.
diff --git a/doc/.gitignore b/doc/.gitignore
@@ -3,6 +3,5 @@ _build/
 generated/
 examples/
 example_thumbs/*.png
-introduction.rst
-tutorial/*.rst
-docstrings/*.rst
+docstrings/
+tutorial/
diff --git a/doc/Makefile b/doc/Makefile
@@ -45,23 +45,20 @@ clean:
 	-rm -rf examples/*
 	-rm -rf example_thumbs/*
 	-rm -rf generated/*
-	-rm -rf introduction_files/*
-	-rm introduction.rst
-	-make -C docstrings clean
-	-make -C tutorial clean
+	-make -C _docstrings clean
+	-make -C _tutorial clean
 
 .PHONY: tutorials
 tutorials:
-	make -C tutorial
+	@mkdir -p tutorial
+	@make -C _tutorial
 
 .PHONY: docstrings
 docstrings:
-	make -C docstrings
+	@mkdir -p docstrings
+	@make -C _docstrings
 
-introduction.rst: introduction.ipynb
-	tools/nb_to_doc.py ./introduction.ipynb
-
-notebooks: tutorials docstrings introduction.rst
+notebooks: tutorials docstrings
 
 html:
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html

diff --git a/doc/docstrings/FacetGrid.ipynb → doc/_docstrings/FacetGrid.ipynb b/doc/docstrings/FacetGrid.ipynb → doc/_docstrings/FacetGrid.ipynb
@@ -280,9 +280,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "seaborn-py38-latest",
+   "display_name": "seaborn-py39-latest",
    "language": "python",
-   "name": "seaborn-py38-latest"
+   "name": "seaborn-py39-latest"
   },
   "language_info": {
    "codemirror_mode": {
@@ -294,7 +294,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.9"
+   "version": "3.9.13"
   }
  },
  "nbformat": 4,

diff --git a/doc/docstrings/JointGrid.ipynb → doc/_docstrings/JointGrid.ipynb b/doc/docstrings/JointGrid.ipynb → doc/_docstrings/JointGrid.ipynb
@@ -222,9 +222,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "seaborn-py38-latest",
+   "display_name": "seaborn-py39-latest",
    "language": "python",
-   "name": "seaborn-py38-latest"
+   "name": "seaborn-py39-latest"
   },
   "language_info": {
    "codemirror_mode": {
@@ -236,7 +236,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.9"
+   "version": "3.9.13"
   }
  },
  "nbformat": 4,

diff --git a/doc/_docstrings/Makefile b/doc/_docstrings/Makefile
@@ -0,0 +1,13 @@
+rst_files := $(patsubst %.ipynb,../docstrings/%.rst,$(wildcard *.ipynb))
+
+docstrings: ${rst_files}
+
+../docstrings/%.rst: %.ipynb
+	../tools/nb_to_doc.py $*.ipynb ../docstrings
+	@cp -r ../docstrings/$*_files ../generated/
+	@if [ -f ../generated/seaborn.$*.rst ]; then \
+	    touch ../generated/seaborn.$*.rst; \
+	 fi
+
+clean:
+	rm -rf ../docstrings
diff --git a/doc/docstrings/PairGrid.ipynb → doc/_docstrings/PairGrid.ipynb b/doc/docstrings/PairGrid.ipynb → doc/_docstrings/PairGrid.ipynb
@@ -249,9 +249,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "seaborn-py38-latest",
+   "display_name": "seaborn-py39-latest",
    "language": "python",
-   "name": "seaborn-py38-latest"
+   "name": "seaborn-py39-latest"
   },
   "language_info": {
    "codemirror_mode": {
@@ -263,7 +263,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.9"
+   "version": "3.9.13"
   }
  },
  "nbformat": 4,

diff --git a/doc/docstrings/axes_style.ipynb → doc/_docstrings/axes_style.ipynb b/doc/docstrings/axes_style.ipynb → doc/_docstrings/axes_style.ipynb
@@ -80,9 +80,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "seaborn-py38-latest",
+   "display_name": "seaborn-py39-latest",
    "language": "python",
-   "name": "seaborn-py38-latest"
+   "name": "seaborn-py39-latest"
   },
   "language_info": {
    "codemirror_mode": {
@@ -94,7 +94,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.9"
+   "version": "3.9.13"
   }
  },
  "nbformat": 4,

diff --git a/doc/docstrings/barplot.ipynb → doc/_docstrings/barplot.ipynb b/doc/docstrings/barplot.ipynb → doc/_docstrings/barplot.ipynb
@@ -117,7 +117,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.9"
+   "version": "3.9.13"
   }
  },
  "nbformat": 4,

diff --git a/doc/docstrings/boxenplot.ipynb → doc/_docstrings/boxenplot.ipynb b/doc/docstrings/boxenplot.ipynb → doc/_docstrings/boxenplot.ipynb
@@ -122,7 +122,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.9"
+   "version": "3.9.13"
   }
  },
  "nbformat": 4,

diff --git a/doc/docstrings/boxplot.ipynb → doc/_docstrings/boxplot.ipynb b/doc/docstrings/boxplot.ipynb → doc/_docstrings/boxplot.ipynb
@@ -165,7 +165,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.9"
+   "version": "3.9.13"
   }
  },
  "nbformat": 4,

diff --git a/doc/docstrings/catplot.ipynb → doc/_docstrings/catplot.ipynb b/doc/docstrings/catplot.ipynb → doc/_docstrings/catplot.ipynb
@@ -182,7 +182,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.9"
+   "version": "3.9.13"
   }
  },
  "nbformat": 4,

diff --git a/doc/docstrings/color_palette.ipynb → doc/_docstrings/color_palette.ipynb b/doc/docstrings/color_palette.ipynb → doc/_docstrings/color_palette.ipynb
@@ -176,9 +176,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "seaborn-py38-latest",
+   "display_name": "seaborn-py39-latest",
    "language": "python",
-   "name": "seaborn-py38-latest"
+   "name": "seaborn-py39-latest"
   },
   "language_info": {
    "codemirror_mode": {
@@ -190,7 +190,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.9"
+   "version": "3.9.13"
   }
  },
  "nbformat": 4,

diff --git a/doc/docstrings/countplot.ipynb → doc/_docstrings/countplot.ipynb b/doc/docstrings/countplot.ipynb → doc/_docstrings/countplot.ipynb
@@ -91,7 +91,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.9"
+   "version": "3.9.13"
   }
  },
  "nbformat": 4,

diff --git a/doc/docstrings/displot.ipynb → doc/_docstrings/displot.ipynb b/doc/docstrings/displot.ipynb → doc/_docstrings/displot.ipynb
@@ -217,9 +217,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "seaborn-py38-latest",
+   "display_name": "seaborn-py39-latest",
    "language": "python",
-   "name": "seaborn-py38-latest"
+   "name": "seaborn-py39-latest"
   },
   "language_info": {
    "codemirror_mode": {
@@ -231,7 +231,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.9"
+   "version": "3.9.13"
   }
  },
  "nbformat": 4,

diff --git a/doc/docstrings/ecdfplot.ipynb → doc/_docstrings/ecdfplot.ipynb b/doc/docstrings/ecdfplot.ipynb → doc/_docstrings/ecdfplot.ipynb
@@ -120,9 +120,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "seaborn-py38-latest",
+   "display_name": "seaborn-py39-latest",
    "language": "python",
-   "name": "seaborn-py38-latest"
+   "name": "seaborn-py39-latest"
   },
   "language_info": {
    "codemirror_mode": {
@@ -134,7 +134,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.9"
+   "version": "3.9.13"
   }
  },
  "nbformat": 4,

diff --git a/doc/docstrings/histplot.ipynb → doc/_docstrings/histplot.ipynb b/doc/docstrings/histplot.ipynb → doc/_docstrings/histplot.ipynb
@@ -461,9 +461,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "seaborn-py38-latest",
+   "display_name": "seaborn-py39-latest",
    "language": "python",
-   "name": "seaborn-py38-latest"
+   "name": "seaborn-py39-latest"
   },
   "language_info": {
    "codemirror_mode": {
@@ -475,7 +475,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.9"
+   "version": "3.9.13"
   }
  },
  "nbformat": 4,

diff --git a/doc/docstrings/jointplot.ipynb → doc/_docstrings/jointplot.ipynb b/doc/docstrings/jointplot.ipynb → doc/_docstrings/jointplot.ipynb
@@ -172,9 +172,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "seaborn-py38-latest",
+   "display_name": "seaborn-py39-latest",
    "language": "python",
-   "name": "seaborn-py38-latest"
+   "name": "seaborn-py39-latest"
   },
   "language_info": {
    "codemirror_mode": {
@@ -186,7 +186,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.9"
+   "version": "3.9.13"
   }
  },
  "nbformat": 4,

diff --git a/doc/docstrings/kdeplot.ipynb → doc/_docstrings/kdeplot.ipynb b/doc/docstrings/kdeplot.ipynb → doc/_docstrings/kdeplot.ipynb
@@ -327,9 +327,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "seaborn-py38-latest",
+   "display_name": "seaborn-py39-latest",
    "language": "python",
-   "name": "seaborn-py38-latest"
+   "name": "seaborn-py39-latest"
   },
   "language_info": {
    "codemirror_mode": {
@@ -341,7 +341,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.9"
+   "version": "3.9.13"
   }
  },
  "nbformat": 4,

diff --git a/doc/docstrings/lineplot.ipynb → doc/_docstrings/lineplot.ipynb b/doc/docstrings/lineplot.ipynb → doc/_docstrings/lineplot.ipynb
@@ -431,9 +431,9 @@
    "hash": "8bdfc9d9da1e36addfcfc8a3409187c45d33387af0f87d0d91e99e8d6403f1c3"
   },
   "kernelspec": {
-   "display_name": "Python 3.9.9 ('seaborn-py39-latest')",
+   "display_name": "seaborn-py39-latest",
    "language": "python",
-   "name": "python3"
+   "name": "seaborn-py39-latest"
   },
   "language_info": {
    "codemirror_mode": {
@@ -445,7 +445,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.9"
+   "version": "3.9.13"
   }
  },
  "nbformat": 4,

diff --git a/doc/docstrings/move_legend.ipynb → doc/_docstrings/move_legend.ipynb b/doc/docstrings/move_legend.ipynb → doc/_docstrings/move_legend.ipynb
@@ -134,9 +134,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "seaborn-py38-latest",
+   "display_name": "seaborn-py39-latest",
    "language": "python",
-   "name": "seaborn-py38-latest"
+   "name": "seaborn-py39-latest"
   },
   "language_info": {
    "codemirror_mode": {
@@ -148,7 +148,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.9"
+   "version": "3.9.13"
   }
  },
  "nbformat": 4,

diff --git a/doc/docstrings/pairplot.ipynb → doc/_docstrings/pairplot.ipynb b/doc/docstrings/pairplot.ipynb → doc/_docstrings/pairplot.ipynb
@@ -203,9 +203,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "seaborn-py38-latest",
+   "display_name": "seaborn-py39-latest",
    "language": "python",
-   "name": "seaborn-py38-latest"
+   "name": "seaborn-py39-latest"
   },
   "language_info": {
    "codemirror_mode": {
@@ -217,7 +217,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.9"
+   "version": "3.9.13"
   }
  },
  "nbformat": 4,

diff --git a/doc/docstrings/plotting_context.ipynb → doc/_docstrings/plotting_context.ipynb b/doc/docstrings/plotting_context.ipynb → doc/_docstrings/plotting_context.ipynb
@@ -88,9 +88,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "seaborn-py38-latest",
+   "display_name": "seaborn-py39-latest",
    "language": "python",
-   "name": "seaborn-py38-latest"
+   "name": "seaborn-py39-latest"
   },
   "language_info": {
    "codemirror_mode": {
@@ -102,7 +102,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.9.9"
+   "version": "3.9.13"
   }
  },
  "nbformat": 4,