Merge pull request #130 from kayjan/add-docs-export

Added: Examples in docstring on displaying pydot with IPython

Author: kayjan

bigtree/dag/export.py

@@ -201,6 +201,12 @@ def dag_to_dot(
     >>> e = DAGNode("e", step=3, parents=[d])
     >>> dag_graph = dag_to_dot(a)
 
+    Display image directly without saving (requires IPython)
+
+    >>> from IPython.display import Image, display
+    >>> plt = Image(dag_graph.create_png())
+    >>> display(plt)
+
     Export to image, dot file, etc.
 
     >>> dag_graph.write_png("tree_dag.png")

bigtree/tree/export.py

@@ -640,6 +640,12 @@ def tree_to_dot(
     >>> e = Node("e", age=35, parent=b)
     >>> graph = tree_to_dot(root)
 
+    Display image directly without saving (requires IPython)
+
+    >>> from IPython.display import Image, display
+    >>> plt = Image(graph.create_png())
+    >>> display(plt)
+
     Export to image, dot file, etc.
 
     >>> graph.write_png("tree.png")