Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Merged
merged 33 commits into from
Jul 25, 2022
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
c6938ce
Do basic conversion of site to pydata_sphinx_theme
mwaskom Jun 4, 2022
24ae1a5
Remove some pae structure customizations we no longer need
mwaskom Jun 4, 2022
1710425
Add some custom CSS
mwaskom Jun 5, 2022
d84005a
Tweak a few more colors
mwaskom Jun 6, 2022
cdb3b21
Remove vestigial div closing tag
mwaskom Jun 6, 2022
99ce236
Reorganize release notes into hierarchical pages
mwaskom Jun 6, 2022
d7b9a2c
Rebuild full docs and fix some resulting issues
mwaskom Jun 6, 2022
206ea8a
Make release note doc refs absolute
mwaskom Jun 7, 2022
a19a446
Convert homepage to use sphinx-design instead of hand-crafted html
mwaskom Jun 7, 2022
37029ce
Remove original custom css
mwaskom Jun 7, 2022
b06b627
Simplify header and put archive switcher in footer
mwaskom Jun 8, 2022
03d7f96
Streamline API docs for objects
mwaskom Jun 9, 2022
eff8212
Play around with templates to fix shrinking content (not perfect yet)
mwaskom Jun 10, 2022
18bd17e
Improve use of horizontal space without sidebars
mwaskom Jun 18, 2022
bd18cd7
Various tweaks
mwaskom Jun 18, 2022
cecbbc4
Convert tutorial homepage source to native sphinx-design directives
mwaskom Jun 19, 2022
18b6ebe
Move intro page into tutorial
mwaskom Jun 19, 2022
a623046
More tweaks
mwaskom Jun 19, 2022
4633967
Tweak theme colors and footer
mwaskom Jun 20, 2022
b986bfb
Remove reference to navbar version
mwaskom Jun 20, 2022
281e37f
Note that error bar tutorial demonstrates new features as of v0.12
mwaskom Jun 24, 2022
1d03546
Update layout customization for new theme features
mwaskom Jun 25, 2022
5fa493e
Various layout and CSS tweaks
mwaskom Jun 27, 2022
b5059c7
Narrow support guidance to StackOverflow
mwaskom Jun 28, 2022
0dfd740
Run all notebooks
mwaskom Jun 28, 2022
f530fa2
Adapt to new dropdown navbar in pydata theme
mwaskom Jun 29, 2022
e6a8e4e
Separate tutorial source and outputs
mwaskom Jun 29, 2022
fd11aec
Separate dostring source and outputs
mwaskom Jun 29, 2022
ce47df8
Add scale API template
mwaskom Jun 29, 2022
8b83089
Update API docs
mwaskom Jul 14, 2022
d9bc10c
Fix requirements
mwaskom Jul 24, 2022
0f0ea3e
Add new objects
mwaskom Jul 24, 2022
9c570a9
Point doc requirements at v0.10 RC for theme
mwaskom Jul 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
5 changes: 2 additions & 3 deletions doc/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,5 @@ _build/
generated/
examples/
example_thumbs/*.png
introduction.rst
tutorial/*.rst
docstrings/*.rst
docstrings/
tutorial/
17 changes: 7 additions & 10 deletions doc/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions doc/docstrings/FacetGrid.ipynb → doc/_docstrings/FacetGrid.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand All @@ -294,7 +294,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.9"
"version": "3.9.13"
}
},
"nbformat": 4,
Expand Down
6 changes: 3 additions & 3 deletions doc/docstrings/JointGrid.ipynb → doc/_docstrings/JointGrid.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand All @@ -236,7 +236,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.9"
"version": "3.9.13"
}
},
"nbformat": 4,
Expand Down
13 changes: 13 additions & 0 deletions doc/_docstrings/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
6 changes: 3 additions & 3 deletions doc/docstrings/PairGrid.ipynb → doc/_docstrings/PairGrid.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand All @@ -263,7 +263,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.9"
"version": "3.9.13"
}
},
"nbformat": 4,
Expand Down
6 changes: 3 additions & 3 deletions doc/docstrings/axes_style.ipynb → doc/_docstrings/axes_style.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand All @@ -94,7 +94,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.9"
"version": "3.9.13"
}
},
"nbformat": 4,
Expand Down
2 changes: 1 addition & 1 deletion doc/docstrings/barplot.ipynb → doc/_docstrings/barplot.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.9"
"version": "3.9.13"
}
},
"nbformat": 4,
Expand Down
2 changes: 1 addition & 1 deletion doc/docstrings/boxenplot.ipynb → doc/_docstrings/boxenplot.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.9"
"version": "3.9.13"
}
},
"nbformat": 4,
Expand Down
2 changes: 1 addition & 1 deletion doc/docstrings/boxplot.ipynb → doc/_docstrings/boxplot.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.9"
"version": "3.9.13"
}
},
"nbformat": 4,
Expand Down
2 changes: 1 addition & 1 deletion doc/docstrings/catplot.ipynb → doc/_docstrings/catplot.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.9"
"version": "3.9.13"
}
},
"nbformat": 4,
Expand Down
6 changes: 3 additions & 3 deletions doc/docstrings/color_palette.ipynb → doc/_docstrings/color_palette.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand All @@ -190,7 +190,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.9"
"version": "3.9.13"
}
},
"nbformat": 4,
Expand Down
2 changes: 1 addition & 1 deletion doc/docstrings/countplot.ipynb → doc/_docstrings/countplot.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.9"
"version": "3.9.13"
}
},
"nbformat": 4,
Expand Down
6 changes: 3 additions & 3 deletions doc/docstrings/displot.ipynb → doc/_docstrings/displot.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand All @@ -231,7 +231,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.9"
"version": "3.9.13"
}
},
"nbformat": 4,
Expand Down
6 changes: 3 additions & 3 deletions doc/docstrings/ecdfplot.ipynb → doc/_docstrings/ecdfplot.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand All @@ -134,7 +134,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.9"
"version": "3.9.13"
}
},
"nbformat": 4,
Expand Down
6 changes: 3 additions & 3 deletions doc/docstrings/histplot.ipynb → doc/_docstrings/histplot.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand All @@ -475,7 +475,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.9"
"version": "3.9.13"
}
},
"nbformat": 4,
Expand Down
6 changes: 3 additions & 3 deletions doc/docstrings/jointplot.ipynb → doc/_docstrings/jointplot.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand All @@ -186,7 +186,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.9"
"version": "3.9.13"
}
},
"nbformat": 4,
Expand Down
6 changes: 3 additions & 3 deletions doc/docstrings/kdeplot.ipynb → doc/_docstrings/kdeplot.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand All @@ -341,7 +341,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.9"
"version": "3.9.13"
}
},
"nbformat": 4,
Expand Down
6 changes: 3 additions & 3 deletions doc/docstrings/lineplot.ipynb → doc/_docstrings/lineplot.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand All @@ -445,7 +445,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.9"
"version": "3.9.13"
}
},
"nbformat": 4,
Expand Down
6 changes: 3 additions & 3 deletions doc/docstrings/move_legend.ipynb → doc/_docstrings/move_legend.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand All @@ -148,7 +148,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.9"
"version": "3.9.13"
}
},
"nbformat": 4,
Expand Down
6 changes: 3 additions & 3 deletions doc/docstrings/pairplot.ipynb → doc/_docstrings/pairplot.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand All @@ -217,7 +217,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.9"
"version": "3.9.13"
}
},
"nbformat": 4,
Expand Down
6 changes: 3 additions & 3 deletions doc/docstrings/plotting_context.ipynb → doc/_docstrings/plotting_context.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand All @@ -102,7 +102,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.9"
"version": "3.9.13"
}
},
"nbformat": 4,
Expand Down