Docs sphinx_gallery capture _repr_html_

docs/gallery/advanced/autogen/context.py

@@ -107,7 +107,7 @@ def add(x, y):
 wg3.add_task('workgraph.get_context', name='get_ctx1', key='sum.add1')
 
 wg.show()
-wg.to_html()
+wg
 
 
 @task.graph()
@@ -161,7 +161,7 @@ def internal_add(x, y):
     value=add1.outputs.result,
 )
 
-wg.to_html()
+wg
 wg.show()
 
 # %%

docs/gallery/advanced/autogen/context_manager.py

@@ -86,11 +86,11 @@ def AddMultiply(x, y, z):
 #
 # How do they compare visually?
 
-AddMultiply.build(x=1, y=2, z=3).to_html()
+AddMultiply.build(x=1, y=2, z=3)
 
 # %%
 
-wg.to_html()
+wg
 
 # %%
 # With the context manager approach, we now gain a clear representation of workflow inputs and their connections to tasks.
@@ -187,7 +187,7 @@ def AddMultiply(x, y, z):
 # %%
 # Let's see what this looks like visually.
 
-wg.to_html()
+wg
 
 # %%
 # Again, we see our workflow inputs, this time clearly organized under the ``add`` and ``multiply`` namespaces, with clear connections to each task.
@@ -279,7 +279,7 @@ def generate_add_multiply_workgraph():
 #
 # Let's have a look at the graph:
 
-wg.to_html()
+wg
 
 # %%
 # You can compare this graph against the one generated by the decorator paradigm (see :ref:`here <howto:combine-workgraphs:add-workgraph>`).
@@ -340,7 +340,7 @@ def generate_add_multiply_workgraph():
     # even though it only needs the result from task2.
     task3_outputs = add(x=1, y=task1_outputs.result)
 
-wg.to_html()
+wg
 
 # %%
 # The graph shows the first executed ``add`` task providing its result to the zone,
@@ -406,7 +406,7 @@ def generate_add_multiply_workgraph():
 # From there, only one result is then fed as the input to the last add task (``add2``), and finally, the global workflow outputs.
 # Lastly, we can see connections from each ``if_zone``'s special ``_wait`` output socket to the ``_wait`` input socket of the ``add2`` task, which represent the explicit waiting between the tasks as defined by the ``>>`` syntax.
 
-wg.to_html()
+wg
 
 # %%
 # .. admonition:: Take home message
@@ -470,7 +470,7 @@ def generate_add_multiply_workgraph():
 # Visually, the ``While`` context manager is depicted as a `while zone`, containing all its child tasks.
 # The zone simplifies the visualization of the loop structure, as it separates the logic executed within the loop from the one outside.
 
-wg.to_html()
+wg
 
 # %%
 # .. note::
@@ -542,7 +542,7 @@ def get_value(data, key):
 # %%
 # Let's inspect the task graph:
 
-wg.to_html()
+wg
 
 # %%
 # We can see with the ``Map`` zone the tasks onto which the input data would be mapped.
@@ -669,7 +669,7 @@ def aggregate_sum(data: spec.dynamic(Any)) -> int:
     ).result
     wg3.outputs.new_sum = new_sum
 
-wg3.to_html()
+wg3
 
 # %%
 print(f'State of WorkGraph : {wg3.state}')

docs/gallery/advanced/autogen/node_graph_programming.py

@@ -74,7 +74,7 @@ def multiply(x, y):
 print(f'Result: {wg.outputs.result.value}')
 
 # Visualize the workgraph
-wg.to_html()
+wg
 
 # %%
 # Conditional logic with the `If Zone` task
@@ -125,7 +125,7 @@ def multiply(x, y):
 assert wg.outputs.result.value == 5
 
 # Visualize the workgraph
-wg.to_html()
+wg
 
 # %%
 # Loops with `While Zone` task
@@ -170,7 +170,7 @@ def multiply(x, y):
 assert wg.outputs.result.value == 15
 
 # Visualize the workgraphs
-wg.to_html()
+wg
 
 # %%
 # Mapping operations with `Map Zone` task
@@ -234,7 +234,7 @@ def calc_sum(data: spec.dynamic(Any)) -> int:
 assert wg.outputs.result.value == 10
 
 # Visualize the workgraph
-wg.to_html()
+wg
 
 # %%
 # Conclusion

docs/gallery/autogen/quick_start.py

@@ -103,12 +103,9 @@ def AddMultiply(x, y, z):
 #
 # Let's build the workflow with some input and visualize it:
 #
-# .. important::
-#
-#    If you are following along in a Jupyter notebook, replace ``wg.to_html()`` with ``wg``.
 
 wg = AddMultiply.build(x=2, y=3, z=4)
-wg.to_html()
+wg
 
 # %%
 # We can see our two tasks, the assignment of the sum to the multiplication task, and the subsequent assignment of the product to the workflow (graph) result.

docs/gallery/concept/autogen/task_concept.py

@@ -31,7 +31,7 @@ def multiply(x, y):
 
 
 # export the task to html file so that it can be visualized in a browser
-add()._task.to_html()
+add()._task
 
 # visualize the task in jupyter-notebook
 # add()._task
@@ -83,7 +83,7 @@ def multiply(x, y):
 
 wg = WorkGraph()
 norm_task = wg.add_task(NormTask, name='norm1')
-norm_task.to_html()
+norm_task
 
 
 ######################################################################

docs/gallery/concept/autogen/workgraph_concept.py

@@ -39,7 +39,7 @@ def add(x, y):
 wg.add_link(add1.outputs.result, add2.inputs.x)
 
 # Visualize the graph
-wg.to_html()
+wg
 
 # %%
 # .. note::
@@ -90,7 +90,7 @@ def add(x, y):
 assert wg.outputs.sum2.value == 2 + (2 + 3)
 
 # Visualize the graph with inputs and outputs
-wg.to_html()
+wg
 
 # %%
 # .. note::

docs/gallery/howto/autogen/annotate_inputs_outputs.py

@@ -116,7 +116,7 @@ def AddMultiplyInputs(x: int, y: int):
 
 
 wg = AddMultiplyInputs.build(x=1, y=2)
-wg.to_html()
+wg
 
 # %%
 # Note how the ``x`` input is passed to ``data.x`` (and similarly for ``y``).
@@ -524,7 +524,7 @@ def AddMultiplyFinal(
         'add_multiply2': {'data': {'x': 3, 'y': 4}},
     },
 )
-wg.to_html()
+wg
 
 # %%
 # In the example above:
@@ -625,7 +625,7 @@ def UseExclude(
         'consume_complex2': {'data': {'pw': {'kpoints': 4, 'parameters': 5}, 'metadata': {}}},
     },
 )
-wg.to_html()
+wg
 
 # %%
 # In the GUI representation, you can see that the graph has a top-level ``structure`` input,

docs/gallery/howto/autogen/combine_workgraphs.py

@@ -69,7 +69,7 @@ def AddMultiplyComposed(minimum, maximum, x, y):
 # See how we're using `AddMultiply` as a regular task? It's as simple as that!
 # This is also clear in when we visualize the workgraph:
 
-wg.to_html()
+wg
 
 # %%
 # .. tip::

docs/gallery/howto/autogen/control-flow.py

@@ -72,7 +72,7 @@ def ForLoop(n, m):
     return m
 
 
-ForLoop.build(n=4, m=0).to_html()
+ForLoop.build(n=4, m=0)
 
 # %%
 # .. important::
@@ -114,7 +114,7 @@ def WhileLoop(n, m):
 
 wg = WhileLoop.build(n=4, m=0)
 
-wg.to_html()
+wg
 
 
 # %%

docs/gallery/howto/autogen/interoperate_with_aiida_core.py

@@ -139,7 +139,7 @@ def AiiDAComponentsWorkflow():
 
 
 wg = AiiDAComponentsWorkflow.build()
-wg.to_html()
+wg
 
 # %%
 # Let's run our ``aiida-core``-powered ``WorkGraph`` and examine the provenance graph:

docs/gallery/howto/autogen/monitor.py

@@ -90,7 +90,7 @@ def TimeMonitor(time, x, y):
     x=1,
     y=2,
 )
-wg.to_html()
+wg
 
 # %%
 wg.run()
@@ -159,7 +159,7 @@ def FileMonitor(x, y, z):
 
 
 wg = FileMonitor.build(x=1, y=2, z=3)
-wg.to_html()
+wg
 
 # %%
 wg.run()

docs/gallery/howto/autogen/parallel.py

@@ -102,7 +102,7 @@ def ParallelSquare(
 # Workflow view
 # """""""""""""
 
-wg.to_html()
+wg
 
 # %%
 # Provenance graph

docs/gallery/howto/autogen/set_task_metadata.py

@@ -65,7 +65,7 @@ def add_and_multiply(x, y, z):
 
 # Build and visualize the graph
 wg = add_and_multiply.build(x=1, y=2, z=3)
-wg.to_html()
+wg
 
 # %%
 # As you can see in the visualization, the task are now labeled "my_add" and "my_multiply" instead of the default function names.

docs/gallery/howto/autogen/shelljob.py

@@ -173,7 +173,7 @@ def ShellAddMultiply(x: int, y: int, z: int) -> int:
 
 # Create a workgraph
 wg = ShellAddMultiply.build(2, 3, 4)
-wg.to_html()
+wg
 
 # %%
 

docs/gallery/migration_from_aiida_core/autogen/workchain.py

@@ -159,7 +159,7 @@ def sum_even_workgraph(N: int):
 
 # The `to_html()` method generates an interactive visualization of the graph.
 # In a Sphinx-Gallery build, this will be embedded directly in the output.
-wg.to_html()
+wg
 
 # %%
 # Execute the WorkGraph and print the result.

docs/gallery/tutorial/autogen/materials_science_ase.py

@@ -95,11 +95,7 @@ def atomization_energy_workflow(molecule_obj: Atoms, atom_obj: Atoms) -> float:
 # %%
 # You can visualize the planned workflow.
 #
-# .. note::
-#
-#    If you run in a Jupyter notebook, replace ``wg.to_html()`` with ``wg``.
-
-wg.to_html()
+wg
 
 
 # %%
@@ -240,7 +236,7 @@ def eos_workflow(atoms: Atoms, scales: list, run_relax: bool = True) -> dict:
 # %%
 # Next, we build the workgraph with the inputs and visualize it:
 wg = eos_workflow.build(atoms=cu, scales=scales)
-wg.to_html()
+wg
 
 # %%
 # Finally, we run the workflow:

docs/source/conf.py

@@ -15,7 +15,6 @@
 import shutil
 from pathlib import Path
 
-
 sys.path.insert(0, os.path.abspath('../..'))
 
 
@@ -67,6 +66,7 @@
     'filename_pattern': '/*',
     'examples_dirs': gallery_src_dirs,  # in sphinx-gallery doc referred as gallery source
     'gallery_dirs': sphinx_src_autogen_dirs,  # path to where to gallery puts generated files
+    'capture_repr': ('_repr_html_', '__repr__'),
 }
 
 exclude_patterns = []
@@ -122,6 +122,8 @@
 
 
 # Function to copy HTML files
+
+
 def copy_html_files(app, exception):
     """
     Copy all .html files from source to build directory, maintaining the directory structure.