DOC: Use Sphinx-gallery animation capture

larsoner · larsoner · commit aaa9cc1c03e7 · 2020-05-21T13:49:53.000-04:00
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -27,7 +27,8 @@ apt-run:  &apt-install
       graphviz \
       fonts-crosextra-carlito \
       fonts-freefont-otf \
-      fonts-humor-sans
+      fonts-humor-sans \
+      optipng
 
 fonts-run:  &fonts-install
   name: Install custom fonts
diff --git a/doc/Makefile b/doc/Makefile
@@ -24,6 +24,9 @@ clean:
 	rm -rf "$(SOURCEDIR)/savefig"
 	rm -rf "$(SOURCEDIR)/sphinxext/__pycache__"
 
+show:
+	@python -c "import webbrowser; webbrowser.open_new_tab('file://$(PWD)/build/html/index.html')"
+
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
diff --git a/doc/_static/mpl.css b/doc/_static/mpl.css
@@ -189,10 +189,6 @@ div.documentwrapper {
 }
 */
 
-div.clearer {
-    clear: both;
-}
-
 div.related h3 {
     display: none;
 }
diff --git a/doc/_templates/autosummary.rst b/doc/_templates/autosummary.rst
@@ -21,11 +21,8 @@
    creates no example file for those (sphinx-gallery/sphinx-gallery#365)
 
 {% else %}
-.. include:: {{module}}.{{objname}}.examples
-
-.. raw:: html
-
-    <div class="clearer"></div>
+.. minigallery:: {{module}}.{{objname}}
+   :add-heading:
 
 {% endif %}
 {% endif %}
diff --git a/doc/_templates/function.rst b/doc/_templates/function.rst
@@ -5,8 +5,5 @@
 
 .. autofunction:: {{ objname }}
 
-.. include:: {{module}}.{{objname}}.examples
-
-.. raw:: html
-
-    <div class="clearer"></div>
+.. minigallery:: {{module}}.{{objname}}
+   :add-heading:
diff --git a/doc/conf.py b/doc/conf.py
@@ -139,6 +139,8 @@ def _check_dependencies():
     'within_subsection_order': gallery_order.subsectionorder,
     'remove_config_comments': True,
     'min_reported_time': 1,
+    'compress_images': ('thumbnails', 'images'),
+    'matplotlib_animations': True,
 }
 
 plot_gallery = 'True'
diff --git a/doc/devel/documenting_mpl.rst b/doc/devel/documenting_mpl.rst
@@ -890,7 +890,9 @@ Miscellaneous
 Adding animations
 -----------------
 
-There is a Matplotlib Google/Gmail account with username ``mplgithub``
+Animations are scraped automatically by Sphinx-gallery. If this is not
+desired,
+there is also a Matplotlib Google/Gmail account with username ``mplgithub``
 which was used to setup the github account but can be used for other
 purposes, like hosting Google docs or Youtube videos.  You can embed a
 Matplotlib animation in the docs by first saving the animation as a
diff --git a/requirements/doc/doc-requirements.txt b/requirements/doc/doc-requirements.txt
@@ -12,5 +12,5 @@ colorspacious
 ipython
 ipywidgets
 numpydoc>=0.8
-sphinx-gallery>=0.5
+sphinx-gallery>=0.7
 sphinx-copybutton

Original file line number	Diff line number	Diff line change
`@@ -189,10 +189,6 @@ div.documentwrapper {`
`189`	`189`	`}`
`190`	`190`	`*/`
`191`	`191`
`192`		`-div.clearer {`
`193`		`- clear: both;`
`194`		`-}`
`195`		`-`
`196`	`192`	`div.related h3 {`
`197`	`193`	`display: none;`
`198`	`194`	`}`
Original file line number	Diff line number	Diff line change
`@@ -139,6 +139,8 @@ def _check_dependencies():`
`139`	`139`	`'within_subsection_order': gallery_order.subsectionorder,`
`140`	`140`	`'remove_config_comments': True,`
`141`	`141`	`'min_reported_time': 1,`
	`142`	`+ 'compress_images': ('thumbnails', 'images'),`
	`143`	`+ 'matplotlib_animations': True,`
`142`	`144`	`}`
`143`	`145`
`144`	`146`	`plot_gallery = 'True'`