Skip to content

Commit 34662f4

Browse files
mwaskommwaskom
authored
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
1 parent fb61ded commit 34662f4

89 files changed

Lines changed: 1047 additions & 1374 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎doc/.gitignore‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,5 @@ _build/
33
generated/
44
examples/
55
example_thumbs/*.png
6-
introduction.rst
7-
tutorial/*.rst
8-
docstrings/*.rst
6+
docstrings/
7+
tutorial/

‎doc/Makefile‎

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -45,23 +45,20 @@ clean:
4545
-rm -rf examples/*
4646
-rm -rf example_thumbs/*
4747
-rm -rf generated/*
48-
-rm -rf introduction_files/*
49-
-rm introduction.rst
50-
-make -C docstrings clean
51-
-make -C tutorial clean
48+
-make -C _docstrings clean
49+
-make -C _tutorial clean
5250

5351
.PHONY: tutorials
5452
tutorials:
55-
make -C tutorial
53+
@mkdir -p tutorial
54+
@make -C _tutorial
5655

5756
.PHONY: docstrings
5857
docstrings:
59-
make -C docstrings
58+
@mkdir -p docstrings
59+
@make -C _docstrings
6060

61-
introduction.rst: introduction.ipynb
62-
tools/nb_to_doc.py ./introduction.ipynb
63-
64-
notebooks: tutorials docstrings introduction.rst
61+
notebooks: tutorials docstrings
6562

6663
html:
6764
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html

doc/docstrings/FacetGrid.ipynb renamed to doc/_docstrings/FacetGrid.ipynb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -280,9 +280,9 @@
280280
],
281281
"metadata": {
282282
"kernelspec": {
283-
"display_name": "seaborn-py38-latest",
283+
"display_name": "seaborn-py39-latest",
284284
"language": "python",
285-
"name": "seaborn-py38-latest"
285+
"name": "seaborn-py39-latest"
286286
},
287287
"language_info": {
288288
"codemirror_mode": {
@@ -294,7 +294,7 @@
294294
"name": "python",
295295
"nbconvert_exporter": "python",
296296
"pygments_lexer": "ipython3",
297-
"version": "3.9.9"
297+
"version": "3.9.13"
298298
}
299299
},
300300
"nbformat": 4,

doc/docstrings/JointGrid.ipynb renamed to doc/_docstrings/JointGrid.ipynb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -222,9 +222,9 @@
222222
],
223223
"metadata": {
224224
"kernelspec": {
225-
"display_name": "seaborn-py38-latest",
225+
"display_name": "seaborn-py39-latest",
226226
"language": "python",
227-
"name": "seaborn-py38-latest"
227+
"name": "seaborn-py39-latest"
228228
},
229229
"language_info": {
230230
"codemirror_mode": {
@@ -236,7 +236,7 @@
236236
"name": "python",
237237
"nbconvert_exporter": "python",
238238
"pygments_lexer": "ipython3",
239-
"version": "3.9.9"
239+
"version": "3.9.13"
240240
}
241241
},
242242
"nbformat": 4,

‎doc/_docstrings/Makefile‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
rst_files := $(patsubst %.ipynb,../docstrings/%.rst,$(wildcard *.ipynb))
2+
3+
docstrings: ${rst_files}
4+
5+
../docstrings/%.rst: %.ipynb
6+
../tools/nb_to_doc.py $*.ipynb ../docstrings
7+
@cp -r ../docstrings/$*_files ../generated/
8+
@if [ -f ../generated/seaborn.$*.rst ]; then \
9+
touch ../generated/seaborn.$*.rst; \
10+
fi
11+
12+
clean:
13+
rm -rf ../docstrings

doc/docstrings/PairGrid.ipynb renamed to doc/_docstrings/PairGrid.ipynb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -249,9 +249,9 @@
249249
],
250250
"metadata": {
251251
"kernelspec": {
252-
"display_name": "seaborn-py38-latest",
252+
"display_name": "seaborn-py39-latest",
253253
"language": "python",
254-
"name": "seaborn-py38-latest"
254+
"name": "seaborn-py39-latest"
255255
},
256256
"language_info": {
257257
"codemirror_mode": {
@@ -263,7 +263,7 @@
263263
"name": "python",
264264
"nbconvert_exporter": "python",
265265
"pygments_lexer": "ipython3",
266-
"version": "3.9.9"
266+
"version": "3.9.13"
267267
}
268268
},
269269
"nbformat": 4,

doc/docstrings/axes_style.ipynb renamed to doc/_docstrings/axes_style.ipynb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -80,9 +80,9 @@
8080
],
8181
"metadata": {
8282
"kernelspec": {
83-
"display_name": "seaborn-py38-latest",
83+
"display_name": "seaborn-py39-latest",
8484
"language": "python",
85-
"name": "seaborn-py38-latest"
85+
"name": "seaborn-py39-latest"
8686
},
8787
"language_info": {
8888
"codemirror_mode": {
@@ -94,7 +94,7 @@
9494
"name": "python",
9595
"nbconvert_exporter": "python",
9696
"pygments_lexer": "ipython3",
97-
"version": "3.9.9"
97+
"version": "3.9.13"
9898
}
9999
},
100100
"nbformat": 4,

doc/docstrings/barplot.ipynb renamed to doc/_docstrings/barplot.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@
117117
"name": "python",
118118
"nbconvert_exporter": "python",
119119
"pygments_lexer": "ipython3",
120-
"version": "3.9.9"
120+
"version": "3.9.13"
121121
}
122122
},
123123
"nbformat": 4,

doc/docstrings/boxenplot.ipynb renamed to doc/_docstrings/boxenplot.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@
122122
"name": "python",
123123
"nbconvert_exporter": "python",
124124
"pygments_lexer": "ipython3",
125-
"version": "3.9.9"
125+
"version": "3.9.13"
126126
}
127127
},
128128
"nbformat": 4,

doc/docstrings/boxplot.ipynb renamed to doc/_docstrings/boxplot.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@
165165
"name": "python",
166166
"nbconvert_exporter": "python",
167167
"pygments_lexer": "ipython3",
168-
"version": "3.9.9"
168+
"version": "3.9.13"
169169
}
170170
},
171171
"nbformat": 4,

0 commit comments

Comments
 (0)