Add images to doc example

Author: saulshanabrook

docs/changelog.md

@@ -19,6 +19,7 @@ _This project uses semantic versioning. Before 1.0.0, this means that every brea
 - Added support for alternative way of creating variables using functions
 - Add NDarray example
 - Render EGraphs with `graphviz` in the notebook
+  - Add images to doc examples
 - Add `%%egglog` magic to the notebook
 
 ## 0.4.0 (2023-05-03)

python/egglog/egraph.py

@@ -603,6 +603,15 @@ def _repr_mimebundle_(self, *args, **kwargs):
     def graphviz(self) -> graphviz.Source:
         return graphviz.Source(self._egraph.to_graphviz_string())
 
+    def _repr_html_(self) -> str:
+        """
+        Add a _repr_html_ to be an SVG to work with sphinx gallery
+        ala https://github.com/xflr6/graphviz/pull/121
+        until this PR is merged and released
+        https://github.com/sphinx-gallery/sphinx-gallery/pull/1138
+        """
+        return self.graphviz.pipe(format="svg").decode()
+
     def display(self):
         """
         Displays the e-graph in the notebook.

python/egglog/examples/eqsat_basic.py

@@ -40,3 +40,4 @@ def __mul__(self, other: Num) -> Num:  # type: ignore[empty-body]
 )
 egraph.run(10)
 egraph.check(eq(expr1).to(expr2))
+egraph

python/egglog/examples/fib.py

@@ -25,3 +25,4 @@ def fib(x: i64Like) -> i64:  # type: ignore[empty-body]
 )
 egraph.run(7)
 egraph.check(eq(fib(i64(7))).to(i64(21)))
+egraph

python/egglog/examples/matrix.py

@@ -181,3 +181,4 @@ def kron(a: Matrix, b: Matrix) -> Matrix:  # type: ignore[empty-body]
 egraph.run(10)
 # Verify it is not simplified
 egraph.check_fail(eq(ex2).to(kron(A, C)))
+egraph

python/egglog/examples/resolution.py

@@ -81,3 +81,4 @@ def pred(x: i64Like) -> Bool:  # type: ignore[empty-body]
 egraph.check(T != F)
 egraph.check(eq(p0).to(F))
 egraph.check(eq(p2).to(F))
+egraph

python/egglog/examples/schedule_demo.py

@@ -30,3 +30,4 @@
 )
 egraph.check(left(i64(10)), right(i64(9)))
 egraph.check_fail(left(i64(11)), right(i64(10)))
+egraph