Add jupyter renderer doc section

vega · Dec 16, 2023 · cb24bd3 · cb24bd3
1 parent 86309ac
commit cb24bd3
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 2 deletions.
diff --git a/doc/user_guide/display_frontends.rst b/doc/user_guide/display_frontends.rst
@@ -40,6 +40,12 @@ The most used built-in renderers are:
   newer versions of JupyterLab_, nteract_, and `VSCode-Python`_, but does not work
   with the `Jupyter Notebook`_, or with tools like nbviewer_ and nbconvert_.
 
+``alt.renderers.enable("jupyter")``
+  *(added in version 5.3.0):* Output the chart using :ref:`user-guide-jupyterchart`. This renderer
+  is compatible with environments that support third-party Jupyter Widgets including
+  JupyterLab_, `Jupyter Notebook`_, `VSCode-Python`_, and `Colab`_.
+  It requires a web connection in order to load relevant Javascript libraries.
+
 In addition, Altair includes the following renderers:
 
 - ``"default"``, ``"colab"``, ``"kaggle"``, ``"zeppelin"``: identical to ``"html"``

diff --git a/doc/user_guide/jupyter_chart.rst b/doc/user_guide/jupyter_chart.rst
@@ -1,7 +1,7 @@
 .. _user-guide-jupyterchart:
 
-JupyterChart Interactivity
-==========================
+JupyterChart
+============
 The ``JupyterChart`` class, introduced in Vega-Altair 5.1, makes it possible to update charts
 after they have been displayed and access the state of :ref:`user-guide-interactions` from Python.