use custom directivy

Author: basnijholt

README.rst

@@ -8,12 +8,7 @@
 
   *Adaptive*: parallel active learning of mathematical functions.
 
-.. raw:: html
-
-   <video autoplay loop muted style="width: 400px; max-width: 100%; margin: 0 auto; display:block;">
-      <source src="_static/logo_docs.mp4" type="video/mp4">
-   </video>
-   <br>
+.. animated-logo::
 
 ``adaptive`` is an open-source Python library designed to
 make adaptive parallel function evaluation simple. With ``adaptive`` you

docs/Makefile

@@ -17,17 +17,11 @@ help:
 source/_static/logo_docs.png: logo.py
 	python logo.py
 
-source/_static/logo_docs.mp4: logo_animated.py
-	python logo_animated.py
-
 # Fake target to avoid the catch-all target
 logo.py:
 	@echo "never executed"
 
-logo_animated.py:
-	@echo "never executed"
-
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
-%: Makefile source/_static/logo_docs.png source/_static/logo_docs.mp4
+%: Makefile source/_static/logo_docs.png
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/logo.py

@@ -52,10 +52,13 @@ def add_rounded_corners(fname, rad):
     return im
 
 
-if __name__ == "__main__":
+def main(fname="source/_static/logo_docs.png"):
     learner = create_and_run_learner()
-    fname = "source/_static/logo_docs.png"
     plot_learner_and_save(learner, fname)
     im = add_rounded_corners(fname, rad=200)
     im.thumbnail((200, 200), Image.ANTIALIAS)  # resize
     im.save(fname)
+
+
+if __name__ == "__main__":
+    main()

docs/logo_animated.py

@@ -70,7 +70,7 @@ def ring(xy):
     return learner
 
 
-if __name__ == "__main__":
+def main(fname="source/_static/logo_docs.mp4"):
     learner = create_and_run_learner()
 
     data = list(learner.data.items())
@@ -92,4 +92,8 @@ def ring(xy):
     ]
 
     ani = animation.ArtistAnimation(fig, artists, blit=True)
-    ani.save("source/_static/logo_docs.mp4", writer=FFMpegWriter(fps=24))
+    ani.save(fname, writer=FFMpegWriter(fps=24))
+
+
+if __name__ == "__main__":
+    main()

docs/source/conf.py

@@ -14,11 +14,17 @@
 import os
 import sys
 
+from docutils import nodes
+from docutils.parsers.rst import Directive
+
 package_path = os.path.abspath("../..")
 # Insert into sys.path so that we can import adaptive here
 sys.path.insert(0, package_path)
 # Insert into PYTHONPATH so that jupyter-sphinx will pick it up
 os.environ["PYTHONPATH"] = ":".join((package_path, os.environ.get("PYTHONPATH", "")))
+# Insert `docs/` such that we can run the logo scripts
+docs_path = os.path.abspath("..")
+sys.path.insert(1, docs_path)
 
 import adaptive  # noqa: E402, isort:skip
 
@@ -154,5 +160,20 @@
 html_logo = "logo_docs.png"
 
 
+class RunLogoAnimated(Directive):
+    def run(self):
+        fname = "_static/logo_docs.mp4"
+        if not os.path.exists(fname):
+            import logo_animated
+
+            print(f"{fname} does not exist.")
+            logo_animated.main(fname)
+        style = "width: 400px; max-width: 100%; margin: 0 auto; display:block;"
+        opts = f'autoplay loop muted style="{style}"'
+        html = f"""<video {opts}><source src="{fname}" type="video/mp4"></video><br>"""
+        return [nodes.raw(text=html, format="html")]
+
+
 def setup(app):
     app.add_css_file("custom.css")  # For the `live_info` widget
+    app.add_directive("animated-logo", RunLogoAnimated)