plugin user API snippets

spacetelescope · Sep 6, 2023 · 2344ef3 · 2344ef3
1 parent c8dce87
commit 2344ef3
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 2 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -52,7 +52,8 @@
     'sphinx.ext.napoleon',
     'sphinx_automodapi.automodapi',
     'sphinx.ext.mathjax',
-    'sphinx_design']
+    'sphinx_design',
+    'sphinx-togglebutton']
 
 # Add any paths that contain templates here, relative to this directory.
 # templates_path = ['_templates']

diff --git a/docs/plugins.rst b/docs/plugins.rst
@@ -76,6 +76,15 @@ can be disabled through the plugin settings.
     * :meth:`lightkurve.LightCurve.flatten`
 
 
+.. note::
+    :class: dropdown
+
+    .. code-block:: python
+
+      flatten = lcviz.plugins['Flatten']
+      flatten.open_in_tray()
+
+
 .. _frequency_analysis:
 
 Frequency Analysis

diff --git a/pyproject.toml b/pyproject.toml
@@ -46,7 +46,8 @@ test = [
 ]
 docs = [
     "sphinx-astropy[confv2]>=1.9.1",
-    "sphinx_design"
+    "sphinx_design",
+    "sphinx-togglebutton"
 ]
 
 [build-system]