Scraper function for sphinx-gallery, in plotly.io

doc/Makefile

@@ -0,0 +1,28 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+PYTHON        ?= python3
+SPHINXOPTS    ?= -j $(shell nproc || getconf _NPROCESSORS_ONLN || 1)
+SPHINXBUILD   ?= $(PYTHON) -m sphinx
+SPHINXPROJ    = plotly
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+
+clean:
+	rm -rf $(BUILDDIR)/*
+	rm -rf auto_examples/
+	rm -rf gen_modules/
+

doc/api.rst

@@ -0,0 +1,15 @@
+API documentation
+=================
+
+API below is generated, a lot of room for customizing the design
+
+
+.. automodule:: plotly.plotly
+   :members:
+
+.. automodule:: plotly.graph_objs
+   :members:
+
+.. automodule:: plotly.tools
+   :members:
+

doc/conf.py

@@ -0,0 +1,199 @@
+# -*- coding: utf-8 -*-
+#
+# plotly documentation build configuration file, created by
+# sphinx-quickstart on Wed May  1 15:00:57 2019.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..'))
+sys.setrecursionlimit(1500)
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.autodoc',
+    'numpydoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.doctest',
+    'sphinx.ext.intersphinx',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.mathjax',
+    'sphinx_gallery.gen_gallery',
+    ]
+
+autosummary_generate = True
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'plotly'
+copyright = u'2019, Plotly'
+author = u'Plotly'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+import plotly
+version = '3.8' #plotly.__version__
+
+# The full version, including alpha/beta/rc tags.
+release = '3.8' #plotly.__version__
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'alabaster'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+html_sidebars = {
+    '**': [
+        'relations.html',  # needs 'show_related': True theme option to display
+        'searchbox.html',
+    ]
+}
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'plotlydoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'plotly.tex', u'plotly Documentation',
+     u'Plotly', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'plotly', u'plotly Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'plotly', u'plotly Documentation',
+     author, 'plotly', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'https://docs.python.org/': None}
+
+from plotly.io._sg_scraper import plotly_sg_scraper
+image_scrapers = ('matplotlib', plotly_sg_scraper,)
+
+
+sphinx_gallery_conf = {
+     'doc_module': ('plotly',),
+     'examples_dirs': '../examples',   # path to your example scripts
+     'backreferences_dir': 'api',
+     'reference_url': {'plotly': None,
+      },
+     'image_scrapers': image_scrapers,
+}
+

doc/index.rst

@@ -0,0 +1,24 @@
+.. plotly documentation master file, created by
+   sphinx-quickstart on Wed May  1 15:00:57 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to plotly's documentation!
+==================================
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Contents:
+
+    auto_examples/index
+    api
+    tutorial
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

doc/tutorial.rst

@@ -0,0 +1,4 @@
+Narrative documentation
+=======================
+
+goes here

examples/README.txt

@@ -0,0 +1,4 @@
+Gallery of examples
+===================
+
+Some examples using plotly.

examples/plot_plotly.py

@@ -0,0 +1,36 @@
+"""
+A simple scatter plot
+=====================
+
+A scatter plot is created with the plotly library. The figure is interactive,
+information are displayed on hover and it is possible to zoom and pan through
+the figure.
+"""
+import plotly.graph_objs as go
+import plotly
+
+# Create random data with numpy
+import numpy as np
+
+N = 200
+random_x = np.random.randn(N)
+random_y_0 = np.random.randn(N)
+random_y_1 = np.random.randn(N) - 1
+
+# Create traces
+trace_0 = go.Scatter(
+    x=random_x,
+    y=random_y_0,
+    mode='markers',
+    name='Above',
+)
+trace_1 = go.Scatter(
+    x=random_x,
+    y=random_y_1,
+    mode='markers',
+    name='Below',
+)
+
+fig = go.Figure(data=[trace_0, trace_1])
+plotly.io.show(fig)
+

examples/plot_plotly_3d.py

@@ -0,0 +1,31 @@
+"""
+Topographical 3D Surface Plot
+=============================
+
+A 3D surface plot showing the topograph of Mount Bruno (Quebec). Try to
+rotate (left button and drag) and scale (scroll) this animated 3D plot.
+"""
+import plotly
+import plotly.graph_objs as go
+
+import pandas as pd
+
+# Read data from a csv
+z_data = pd.read_csv('https://raw.githubusercontent.com/plotly/datasets/master/api_docs/mt_bruno_elevation.csv')
+
+data = [go.Surface(z=z_data)
+       ]
+layout = go.Layout(
+    title='Mt Bruno Elevation',
+    autosize=False,
+    width=600,
+    height=600,
+    margin=dict(
+        l=65,
+        r=50,
+        b=65,
+        t=90
+    )
+)
+fig = go.Figure(data=data, layout=layout)
+plotly.io.show(fig)

plotly/io/_base_renderers.py

@@ -6,10 +6,12 @@
 import os
 
 import six
-from plotly.io import to_json, to_image
+from plotly.io import to_json, to_image, write_image
 from plotly import utils, optional_imports
 from plotly.io._orca import ensure_server
 from plotly.offline.offline import _get_jconfig, get_plotlyjs
+from plotly.offline import plot
+from plotly.tools import return_figure_from_figure_or_data 
 
 ipython_display = optional_imports.get_module('IPython.display')
 IPython = optional_imports.get_module('IPython')
@@ -631,3 +633,21 @@ def render(self, fig_dict):
             default_height='100%',
         )
         open_html_in_browser(html, self.using, self.new, self.autoraise)
+
+
+class SphinxGalleryRenderer(ExternalRenderer):
+
+    def render(self, fig_dict):
+        stack = inspect.stack()
+        # Name of script from which plot function was called is retrieved
+        try:
+            filename = stack[3].filename # let's hope this is robust...
+        except: #python 2
+            filename = stack[3][1]
+        filename_root, _ = os.path.splitext(filename)
+        filename_html = filename_root + '.html'
+        filename_png = filename_root + '.png'
+        figure = return_figure_from_figure_or_data(fig_dict, True)
+        _ = plot(fig_dict, auto_open=False,
+                 filename=filename_html)
+        write_image(figure, filename_png)

plotly/io/_renderers.py

@@ -12,7 +12,8 @@
 from plotly.io._base_renderers import (
     MimetypeRenderer, ExternalRenderer, PlotlyRenderer, NotebookRenderer,
     KaggleRenderer, ColabRenderer, JsonRenderer, PngRenderer, JpegRenderer,
-    SvgRenderer, PdfRenderer, BrowserRenderer, IFrameRenderer)
+    SvgRenderer, PdfRenderer, BrowserRenderer, IFrameRenderer,
+    SphinxGalleryRenderer)
 from plotly.io._utils import validate_coerce_fig_to_dict
 
 ipython = optional_imports.get_module('IPython')
@@ -394,6 +395,7 @@ def show(fig, renderer=None, validate=True, **kwargs):
 renderers['chrome'] = BrowserRenderer(config=config, using='chrome')
 renderers['chromium'] = BrowserRenderer(config=config, using='chromium')
 renderers['iframe'] = IFrameRenderer(config=config)
+renderers['sphinx'] = SphinxGalleryRenderer()
 
 # Set default renderer
 # --------------------

plotly/io/_sg_scraper.py

@@ -0,0 +1,103 @@
+# This module defines an image scraper for sphinx-gallery
+# https://sphinx-gallery.github.io/
+# which can be used by projects using plotly in their documentation.
+# This module monkey-patches plotly.offline.plot, so we do not
+# import it in __init__.py
+import inspect, os
+
+import plotly
+from glob import glob
+import shutil
+
+plotly.io.renderers.default = 'sphinx' 
+
+
+def plotly_sg_scraper(block, block_vars, gallery_conf, **kwargs):
+    """Scrape Plotly figures.
+
+    Since the monkey-patched version of plotly.offline.plot generates
+    both html and static png files, we simply crawl these files and give
+    them the appropriate path.
+
+    Parameters
+    ----------
+    block : tuple
+        A tuple containing the (label, content, line_number) of the block.
+    block_vars : dict
+        Dict of block variables.
+    gallery_conf : dict
+        Contains the configuration of Sphinx-Gallery
+    **kwargs : dict
+        Additional keyword arguments to pass to
+        :meth:`~matplotlib.figure.Figure.savefig`, e.g. ``format='svg'``.
+        The ``format`` kwarg in particular is used to set the file extension
+        of the output file (currently only 'png' and 'svg' are supported).
+
+    Returns
+    -------
+    rst : str
+        The ReSTructuredText that will be rendered to HTML containing
+        the images.
+
+    Notes
+    -----
+    Add this function to the image scrapers 
+    """
+    examples_dirs = gallery_conf['examples_dirs']
+    if isinstance(examples_dirs, (list, tuple)):
+        examples_dirs = examples_dirs[0]
+    pngs = sorted(glob(os.path.join(examples_dirs,
+                            '*.png')))
+    htmls = sorted(glob(os.path.join(examples_dirs,
+                            '*.html')))
+    image_path_iterator = block_vars['image_path_iterator']
+    image_names = list()
+    seen = set()
+    for html, png in zip(htmls, pngs):
+        if png not in seen:
+            seen |= set(png)
+            this_image_path_png = image_path_iterator.__next__()
+            this_image_path_html = (os.path.splitext(
+                                    this_image_path_png)[0] + '.html')
+            image_names.append(this_image_path_html)
+            shutil.move(png, this_image_path_png)
+            shutil.move(html, this_image_path_html)
+    # Use the `figure_rst` helper function to generate rST for image files
+    return figure_rst(image_names, gallery_conf['src_dir'])
+
+
+def figure_rst(figure_list, sources_dir):
+    """Generate RST for a list of PNG filenames.
+
+    Depending on whether we have one or more figures, we use a
+    single rst call to 'image' or a horizontal list.
+
+    Parameters
+    ----------
+    figure_list : list
+        List of strings of the figures' absolute paths.
+    sources_dir : str
+        absolute path of Sphinx documentation sources
+
+    Returns
+    -------
+    images_rst : str
+        rst code to embed the images in the document
+    """
+
+    figure_paths = [os.path.relpath(figure_path, sources_dir)
+                    .replace(os.sep, '/').lstrip('/')
+                    for figure_path in figure_list]
+    images_rst = ""
+    figure_name = figure_paths[0]
+    ext = os.path.splitext(figure_name)[1]
+    figure_path = os.path.join('images', os.path.basename(figure_name))
+    images_rst = SINGLE_HTML % figure_path
+    return images_rst
+
+
+SINGLE_HTML = """
+.. raw:: html
+    :file: %s
+"""
+

plotly/tests/test_optional/test_jupyter/package.json

@@ -15,6 +15,8 @@
     "ecstatic": "^2.1.0",
     "tap-parser": "^2.0.0",
     "tape": "^4.6.0",
-    "xhr": "^2.2.2"
+    "xhr": "^2.2.2",
+    "electron": "^1.8.4",
+    "orca": "^1.2.1"
   }
 }

plotly/tests/test_orca/test_sg_scraper.py

@@ -0,0 +1,60 @@
+import plotly
+import os
+import shutil
+import pytest
+
+
+# Fixtures
+# --------
+@pytest.fixture()
+def setup():
+    # Reset orca state
+    plotly.io.orca.config.restore_defaults(reset_server=False)
+
+
+# Run setup before every test function in this file
+pytestmark = pytest.mark.usefixtures("setup")
+
+
+def execute_plotly_example():
+    """
+    Some typical code which would go inside a gallery example.
+    """
+    import plotly.graph_objs as go
+
+    # Create random data with numpy
+    import numpy as np
+
+    N = 200
+    random_x = np.random.randn(N)
+    random_y_0 = np.random.randn(N)
+    random_y_1 = np.random.randn(N) - 1
+
+    # Create traces
+    trace_0 = go.Scatter(
+        x=random_x,
+        y=random_y_0,
+        mode='markers',
+        name='Above',
+    )
+
+    fig = go.Figure(data=[trace_0])
+    plotly.io.show(fig)
+
+
+def test_scraper():
+    from plotly.io._sg_scraper import plotly_sg_scraper
+    # test that monkey-patching worked ok
+    assert plotly.io.renderers.default == 'sphinx'
+    # Use dummy values for arguments of plotly_sg_scraper
+    block = '' # we don't need actually code
+    import tempfile
+    tempdir = tempfile.mkdtemp()
+    gallery_conf = {'src_dir':tempdir,
+                    'examples_dirs':'plotly/tests/test_orca'}
+    names = iter(['0', '1', '2'])
+    block_vars = {'image_path_iterator':names}
+    execute_plotly_example()
+    res = plotly_sg_scraper(block, block_vars, gallery_conf)
+    shutil.rmtree(tempdir)
+    assert ".. raw:: html" in res

tox.ini

@@ -74,6 +74,7 @@ deps=
     optional: matplotlib==2.2.3
     optional: xarray==0.10.9
     optional: scikit-image==0.13.1
+    optional: psutil==5.6.2
     plot_ly: pandas==0.23.2
     plot_ly: numpy==1.14.3
     plot_ly: ipywidgets==7.2.0