ENH: add a functional funtional line

Also set up sphinx gallery

Author: tacaswell

.gitignore

@@ -80,3 +80,23 @@ target/
 
 #Ipython Notebook
 .ipynb_checkpoints
+
+
+# Documentation generated files #
+#################################
+# sphinx build directory
+docs/_build
+docs/source/api/_as_gen
+# autogenerated by sphinx-gallery
+docs/source/gallery/
+lib/dateutil
+examples/*/*.bmp
+examples/*/*.eps
+examples/*/*.pdf
+examples/*/*.png
+examples/*/*.svg
+examples/*/*.svgz
+examples/tests/*
+!examples/tests/backend_driver_sgskip.py
+result_images
+doc/_static/constrained_layout*.png

data_prototype/containers.py

@@ -0,0 +1,32 @@
+import numpy as np
+
+
+class DataContainer:
+    def query(self, data_bounds, size, xscale=None, yscale=None):
+        raise NotImplementedError
+
+
+class ArrayContainer:
+    def __init__(self, **data):
+        self._data = data
+
+    def query(self, data_bounds, size, xscale=None, yscale=None):
+        return dict(self._data)
+
+
+class FuncContainer:
+    def __init__(self, xfuncs, yfuncs=None, xyfuncs=None):
+        self._xfuncs = xfuncs or {}
+        self._yfuncs = yfuncs or {}
+        self._xyfuncs = xyfuncs or {}
+
+    def query(self, data_bounds, size, xscale=None, yscale=None):
+        xmin, xmax, ymin, ymax = data_bounds
+        xpix, ypix = size
+        x_data = np.linspace(xmin, xmax, int(xpix) * 2)
+        y_data = np.linspace(ymin, ymax, int(ypix) * 2)
+        return dict(
+            **{k: f(x_data) for k, f in self._xfuncs.items()},
+            **{k: f(y_data) for k, f in self._yfuncs.items()},
+            **{k: f(x_data, y_data) for k, f in self._xyfuncs.items()}
+        )

data_prototype/wrappers.py

@@ -0,0 +1,39 @@
+from matplotlib.lines import Line2D as _Line2D
+
+
+class ProxyWrapper:
+    _privtized_methods = ()
+    _wrapped_class = None
+    _wrapped_instance = None
+
+    def draw(self, renderer):
+        raise NotImplementedError
+
+    def __getattr__(self, key):
+        if key in self._privtized_methods:
+            raise AttributeError(f"The method {key} has been privitized")
+        if key[0] == "_" and key[1:] in self._privtized_methods:
+            return getattr(self._wrapped_instance, key[1:])
+        return getattr(self._wrapped_instance, key)
+
+    def __setattr__(self, key, value):
+        if hasattr(self._wrapped_instance, key):
+            setattr(self._wrapped_instance, key, value)
+        else:
+            super().__setattr__(key, value)
+
+
+class LineWrapper(ProxyWrapper):
+    _wrapped_class = _Line2D
+    _privtized_methods = set(["set_xdata", "set_ydata", "set_data"])
+
+    def __init__(self, data, /, **kwargs):
+        self._wrapped_instance = self._wrapped_class([], [], **kwargs)
+        self.data = data
+
+    def draw(self, renderer):
+        ax = self._wrapped_instance.axes
+        ax_bbox = ax.get_window_extent(renderer)
+        data = self.data.query([*ax.get_xlim(), *ax.get_ylim()], ax_bbox.size)
+        self._wrapped_instance.set_data(data["x"], data["y"])
+        return self._wrapped_instance.draw(renderer)

docs/source/conf.py

@@ -17,10 +17,13 @@
 # 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 os
 # import sys
 # sys.path.insert(0, os.path.abspath('.'))
+from pathlib import Path
 
+# are we running circle CI?
+CIRCLECI = 'CIRCLECI' in os.environ
 
 # -- General configuration ------------------------------------------------
 
@@ -43,17 +46,61 @@
     'matplotlib.sphinxext.plot_directive',
     'numpydoc',
     'sphinx_copybutton',
+    'sphinx_gallery.gen_gallery',
 ]
 
 # Configuration options for plot_directive. See:
 # https://github.com/matplotlib/matplotlib/blob/f3ed922d935751e08494e5fb5311d3050a3b637b/lib/matplotlib/sphinxext/plot_directive.py#L81
 plot_html_show_source_link = False
 plot_html_show_formats = False
 
+
 # Generate the API documentation when building
 autosummary_generate = True
 numpydoc_show_class_members = False
 
+is_release_build = False
+
+# Sphinx gallery configuration
+
+def matplotlib_reduced_latex_scraper(block, block_vars, gallery_conf,
+                                     **kwargs):
+    """
+    Reduce srcset when creating a PDF.
+
+    Because sphinx-gallery runs *very* early, we cannot modify this even in the
+    earliest builder-inited signal. Thus we do it at scraping time.
+    """
+    from sphinx_gallery.scrapers import matplotlib_scraper
+
+    if gallery_conf['builder_name'] == 'latex':
+        gallery_conf['image_srcset'] = []
+    return matplotlib_scraper(block, block_vars, gallery_conf, **kwargs)
+
+
+sphinx_gallery_conf = {
+    'examples_dirs': ['../../examples', ],
+    'filename_pattern': '^((?!sgskip).)*$',
+    'gallery_dirs': ['gallery'],
+    'doc_module': ('data_prototype',),
+    'reference_url': {
+        'matplotlib': None,
+    },
+    'backreferences_dir': Path('api') / Path('_as_gen'),
+    'remove_config_comments': True,
+    'min_reported_time': 1,
+    'thumbnail_size': (320, 224),
+    'image_scrapers': (matplotlib_reduced_latex_scraper, ),
+    # Compression is a significant effort that we skip for local and CI builds.
+    'compress_images': ('thumbnails', 'images') if is_release_build else (),
+    'matplotlib_animations': True,
+    'image_srcset': ["2x"],
+    'junit': '../test-results/sphinx-gallery/junit.xml' if CIRCLECI else '',
+}
+
+mathmpl_fontsize = 11.0
+mathmpl_srcset = ['2x']
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
@@ -105,9 +152,8 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
-import sphinx_rtd_theme
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+html_theme = "mpl_sphinx_theme"
+
 
 # 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

docs/source/index.rst

@@ -11,5 +11,6 @@ data_prototype Documentation
 
    installation
    usage
+   gallery/index.rst
    release-history
    min_versions

examples/README.rst

@@ -0,0 +1,5 @@
+========
+Examples
+========
+
+Examples used in the rapid prototyping of this project.

examples/first.py

@@ -0,0 +1,21 @@
+"""
+=================
+A functional line
+=================
+
+The hello-world
+"""
+
+import matplotlib.pyplot as plt
+import numpy as np
+
+from data_prototype.wrappers import LineWrapper
+from data_prototype.containers import FuncContainer
+
+fc = FuncContainer({'x': lambda x: x, 'y': lambda x: np.sin(x)})
+lw = LineWrapper(fc, lw=5, color='green')
+
+fig, ax = plt.subplots()
+ax.add_artist(lw)
+ax.set_xlim(0, np.pi * 2)
+ax.set_ylim(-1.1, 1.1)