DOC(terms): +plottable

Author: ankostis

docs/source/arch.rst

@@ -332,6 +332,16 @@ Architecture
         (after a successful intermediate :term:`compilation`), or manually,
         by calling :func:`.reset_abort()`.
 
+    plottable
+        Objects that can plot their graph network, such as those inheriting :class:`.Plottable`,
+        (:class:`.NetworkOperation`, :class:`.Network`, :class:`.ExecutionPlan`m :class:`.Solution`)
+        or a |pydot.Dot|_ instance (the result of the :meth:`Plottable.plot()` method).
+
+        Such objects may render as SVG in *Jupter notebooks* (through their ``plot()`` method)
+        and can render in a Sphinx site with with the :rst:dir:`graphtik` *RsT directive*.
+        You may control the rendered image as explained in the *tip*  of
+        the :ref:`plotting` section.
+
 
 .. default-role:: obj
 .. |v410-flowchart| raw:: html

docs/source/index.rst

@@ -111,7 +111,7 @@ Run the graph-operation and request a subset of the outputs:
    >>> solution
    {'a_minus_ab': -8}
 
-Solutions are plottable as well:
+Solutions are :term:`plottable` as well:
 
    >>> solution.plot('solution.svg')      # doctest: +SKIP
 

docs/source/plotting.rst

@@ -8,7 +8,7 @@ Plotting
 --------
 
 For :ref:`debugging` it is necessary to visualize the graph-operation.
-You may plot the original plot and annotate on top the *execution plan* and
+You may plot any :term:`plottable` and annotate on top the *execution plan* and
 solution of the last computation, calling methods with arguments like this::
 
    netop.plot(show=True)              # open a matplotlib window
@@ -232,8 +232,8 @@ which you may :graphtik:`reference <addmul-anchor>` with this syntax:
    the code contains just one variable assignment receiving a subclass
    of :class:`.Plottable` or |pydot.Dot|_ instance.
 
-   Additionally, the doctest code producing the *plottable* does not have to be contained
-   in the *graphtik* directive.
+   Additionally, the doctest code producing the :term:`plottable`\s does not have
+   to be contained in the *graphtik* directive as a whole.
 
    So the above could have been written simply like this:
 

graphtik/plot.py

@@ -389,7 +389,7 @@ def supported_plot_formats() -> List[str]:
 
 def render_pydot(dot: pydot.Dot, filename=None, show=False, jupyter_render: str = None):
     """
-    Render a |pydot.Dot|_ instance with `Graphviz`_ in a file/matplotlib or return it for Jupyter.
+    Render a |pydot.Dot|_ instance with `Graphviz`_ in a file and/or in a matplotlib window.
 
     :param dot:
         the pre-built |pydot.Dot|_ instance

graphtik/sphinxext/_graphtikbuilder.py

@@ -36,7 +36,7 @@ def __setitem__(self, k, v):
 
 
 class GraphtikPlotsBuilder(doctestglobs.ExposeGlobalsDocTestBuilder):
-    """Retrieve *plottable* from doctests globals and render them. """
+    """Retrieve a :term:`plottable` from doctests globals and render them. """
 
     run_empty_code = True