add page (and screenshot) for plugin API access

spacetelescope · Oct 18, 2024 · 6e89084 · 6e89084
1 parent 24f32a2
commit 6e89084
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 0 deletions.
diff --git a/docs/images/api_hint_screenshot.png b/docs/images/api_hint_screenshot.png
diff --git a/docs/index.rst b/docs/index.rst
@@ -40,4 +40,5 @@ Reference/API
 
    installation.rst
    plugins.rst
+   plugin_api.rst
    reference/api.rst
diff --git a/docs/plugin_api.rst b/docs/plugin_api.rst
@@ -0,0 +1,20 @@
+.. _plugin-apis:
+
+*********************
+Accessing Plugin APIs
+*********************
+
+Each plugin object is wrapped by a public user API which enables interacting with the plugin from
+the notebook directly.  The plugin API object for each plugin is accessible through ``viz.plugins``.
+For example:
+
+.. code-block:: python
+
+  plugin = viz.plugins['Plot Options']
+  plugin.open_in_tray()
+  plugin.show('popout')
+
+When running in a notebook or lab environment, plugins provide API hints directly in the UI.  To enable these, toggle the ``<>`` button in the top of the plugin.
+
+.. figure:: images/api_hint_screenshot.png
+    :alt: Screenshot of API hints in the UI