Imporve config

Author: FBumann

README.md

@@ -105,13 +105,13 @@ xpx(da).line(color=None)  # time→x, city→facet_col
 Customize label extraction and slot assignment behavior:
 
 ```python
-import xarray_plotly as xp
+from xarray_plotly import config, xpx
 
 # View current options
-xp.config.get_options()
+config.get_options()
 
-# Set globally
-with xp.config.set_options(label_include_units=False):
+# Set globally (temporary)
+with config.set_options(label_include_units=False):
     fig = xpx(da).line()  # Labels won't include units
 ```
 

docs/api.md

@@ -47,20 +47,21 @@ The accessor style (`da.plotly.line()`) works but doesn't provide IDE code compl
 Customize label extraction and slot assignment behavior:
 
 ```python
-import xarray_plotly as xp
+from xarray_plotly import config, xpx
 
 # View current options
-xp.config.get_options()
+config.get_options()
 
 # Set options (works as context manager)
-with xp.config.set_options(label_include_units=False):
+with config.set_options(label_include_units=False):
     fig = xpx(da).line()
 ```
 
 ::: xarray_plotly.config
     options:
       show_root_heading: true
       members:
+        - notebook
         - get_options
         - set_options
         - Options

docs/examples/plot-types.ipynb

@@ -17,12 +17,11 @@
    "source": [
     "import numpy as np\n",
     "import pandas as pd\n",
-    "import plotly.io as pio\n",
     "import xarray as xr\n",
     "\n",
-    "from xarray_plotly import xpx\n",
+    "from xarray_plotly import config, xpx\n",
     "\n",
-    "pio.renderers.default = \"notebook\""
+    "config.notebook()  # Configure Plotly for notebook rendering"
    ]
   },
   {

docs/getting-started.ipynb

@@ -43,13 +43,11 @@
    "source": [
     "import numpy as np\n",
     "import pandas as pd\n",
-    "import plotly.io as pio\n",
     "import xarray as xr\n",
     "\n",
-    "from xarray_plotly import xpx  # Provides full IDE code completion\n",
+    "from xarray_plotly import config, xpx\n",
     "\n",
-    "# Set renderer for mkdocs-jupyter compatibility\n",
-    "pio.renderers.default = \"notebook\""
+    "config.notebook()  # Configure Plotly for notebook rendering"
    ]
   },
   {
@@ -211,6 +209,25 @@
     "fig"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Configuration\n",
+    "\n",
+    "Customize label extraction and other behavior with the config module:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# View current options\n",
+    "config.get_options()"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},

xarray_plotly/config.py

@@ -101,8 +101,8 @@ def get_options() -> dict[str, Any]:
 
     Examples
     --------
-    >>> import xarray_plotly as xp
-    >>> xp.get_options()
+    >>> from xarray_plotly import config
+    >>> config.get_options()
     {'label_use_long_name': True, 'label_include_units': True, ...}
     """
     return _options.to_dict()
@@ -142,12 +142,12 @@ def set_options(
     --------
     Set globally:
 
-    >>> import xarray_plotly as xp
-    >>> xp.config.set_options(label_include_units=False)
+    >>> from xarray_plotly import config
+    >>> config.set_options(label_include_units=False)
 
     Use as context manager:
 
-    >>> with xp.config.set_options(label_include_units=False):
+    >>> with config.set_options(label_include_units=False):
     ...     fig = xpx(da).line()  # No units in labels
     >>> # Units are back after the context
     """
@@ -181,3 +181,23 @@ def set_options(
         _options.label_include_units = old_values["label_include_units"]
         _options.label_unit_format = old_values["label_unit_format"]
         _options.slot_orders = old_values["slot_orders"]
+
+
+def notebook(renderer: str = "notebook") -> None:
+    """
+    Configure Plotly for Jupyter notebook rendering.
+
+    Parameters
+    ----------
+    renderer : str, optional
+        The Plotly renderer to use. Default is "notebook".
+        Other options include "jupyterlab", "colab", "kaggle", etc.
+
+    Examples
+    --------
+    >>> from xarray_plotly import config
+    >>> config.notebook()  # Configure for Jupyter notebooks
+    """
+    import plotly.io as pio
+
+    pio.renderers.default = renderer