Split pages (#20)

Author: harupy

docs/source/examples.rst

@@ -0,0 +1,8 @@
+basic
+=====
+
+.. plotly::
+
+   import plotly.express as px
+
+   px.scatter(x=[0, 1, 2, 3, 4], y=[0, 1, 4, 9, 16])

docs/source/examples/basic.rst

@@ -0,0 +1,8 @@
+
+doctest
+=======
+
+.. plotly::
+
+   >>> import plotly.express as px
+   >>> px.scatter(x=[0, 1, 2, 3, 4], y=[0, 1, 4, 9, 16])

docs/source/examples/doctest.rst

@@ -0,0 +1,24 @@
+fig-vars
+========
+
+Single
+~~~~~~
+
+.. plotly::
+   :fig-vars: fig1
+
+   import plotly.express as px
+
+   fig1 = px.scatter(x=[0, 1, 2, 3, 4], y=[0, 1, 4, 9, 16])
+
+
+Multiple
+~~~~~~~~
+
+.. plotly::
+   :fig-vars: fig1, fig2
+
+   import plotly.express as px
+
+   fig1 = px.scatter(x=[0, 1, 2, 3, 4], y=[0, 1, 4, 9, 16])
+   fig2 = px.scatter(x=[4, 3, 2, 1, 0], y=[0, 1, 4, 9, 16])

docs/source/examples/fig-vars.rst

@@ -0,0 +1,9 @@
+function
+========
+
+test_func.py
+
+.. literalinclude:: test_func.py
+   :language: python
+
+.. plotly:: examples/test_func.py func

docs/source/examples/function.rst

@@ -0,0 +1,20 @@
+iframe-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"

docs/source/examples/iframe-size.rst

@@ -0,0 +1,15 @@
+.. _examples:
+
+Examples
+========
+
+
+.. toctree::
+   :maxdepth: 2
+
+   basic
+   doctest
+   function
+   fig-vars
+   precode
+   iframe-size

docs/source/examples/index.rst

@@ -0,0 +1,23 @@
+
+precode
+=======
+
+By default, the following code will be executed before running each code block. This allows to use
+``np``, ``plotly``, ``go``, and ``px`` without importing them.
+
+.. code-block:: python
+
+   import numpy as np
+   import plotly
+   import plotly.graph_objects as go
+   import plotly.express as px
+
+.. plotly::
+   :fig-vars: fig1, fig2
+
+   x = np.arange(5)
+   y = x ** 2
+
+   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)

docs/source/examples/precode.rst

@@ -10,7 +10,7 @@ Welcome to sphinx-plotly-directive's documentation!
    :maxdepth: 2
    :caption: Contents:
 
-   examples
+   examples/index
 
 Indices and tables
 ==================