Add iframe-width and height options (#19)

Author: harupy

docs/source/examples.rst

@@ -72,3 +72,25 @@ By default, the following code will be executed before running each code block.
    title = "plotly version: {}".format(plotly.__version__)
    fig1 = go.Figure(go.Scatter(x=x, y=y), layout=dict(title=title))
    fig2 = px.scatter(x=x, y=y, title=title)
+
+
+Specify figure size
+~~~~~~~~~~~~~~~~~~~
+
+.. plotly::
+   :iframe-width: 500px
+   :iframe-height: 300px
+
+   import plotly.express as px
+
+   px.scatter(x=[0, 1, 2, 3, 4], y=[0, 1, 4, 9, 16])
+
+
+You can set the default ``iframe-width`` and ``iframe-height`` by specifying ``plotly_iframe_width`` (default: ``"100%"``) and ``plotly_iframe_height`` (default: ``"500px"``) in ``conf.py``.
+
+.. code-block:: python
+
+   # conf.py
+
+   plotly_iframe_width = "500px"
+   plotly_iframe_height = "300px"

sphinx_plotly_directive/__init__.py

@@ -256,6 +256,8 @@ class PlotlyDirective(Directive):
         "encoding": directives.encoding,
         "caption": directives.unchanged,
         "fig-vars": _option_fig_vars,
+        "iframe-width": directives.unchanged,
+        "iframe-height": directives.unchanged,
     }
 
     def run(self):
@@ -680,6 +682,8 @@ def run(arguments, content, options, state_machine, state, lineno):
     options_copy = copy.deepcopy(options)
 
     options.setdefault("include-source", config.plotly_include_source)
+    options.setdefault("iframe-width", config.plotly_iframe_width)
+    options.setdefault("iframe-height", config.plotly_iframe_height)
     keep_context = "context" in options
     context_opt = None if not keep_context else options["context"]
 
@@ -853,8 +857,8 @@ def run(arguments, content, options, state_machine, state, lineno):
             multi_figure=len(figures) > 1,
             options=opts,
             figures=figures,
-            iframe_width=config.plotly_iframe_width,
-            iframe_height=config.plotly_iframe_height,
+            iframe_width=options["iframe-width"],
+            iframe_height=options["iframe-height"],
             source_code=source_code,
             html_show_formats=config.plotly_html_show_formats and len(figures),
             caption=caption,