Skip to content

Commit baf93ff

Browse files
committed
update doc for iframe size
1 parent 6bd9dde commit baf93ff

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

sphinx_plotly_directive/__init__.py

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,14 @@
8585
figure. This overwrites the caption given in the content, when the plot
8686
is generated from a file.
8787
88+
iframe-width
89+
The width of the iframe in which a plotly figure is rendered. The default can be changed
90+
using the `plotly_iframe_width` variable in :file:`conf.py`.
91+
92+
iframe-height
93+
The height of the iframe in which a plotly figure is rendered. The default can be changed
94+
using the `plotly_iframe_height` variable in :file:`conf.py`.
95+
8896
Additionally, this directive supports all of the options of the `image`
8997
directive, except for *target* (since plot will add its own target). These
9098
include *alt*, *height*, *width*, *scale*, *align* and *class*.
@@ -136,10 +144,10 @@
136144
helper modules for all code are located.
137145
138146
plotly_iframe_width
139-
The width of the iframe that stores a plotly figure. Defaults to "100%".
147+
The width of the iframe in which a plotly figure is rendered. The default is "100%".
140148
141149
plotly_iframe_height
142-
The width of the iframe that stores a plotly figure. Defaults to "500px".
150+
The height of the iframe in which a plotly figure is rendered. The default is "500px".
143151
144152
plotly_template
145153
Provide a customized template for preparing restructured text.

0 commit comments

Comments
 (0)