initial commit for bokeh-plot ext, incomplete but generates output

bokeh/sphinxext/bokeh_plot.py

@@ -0,0 +1,100 @@
+"""
+
+"""
+from __future__ import absolute_import
+
+from docutils import nodes
+from docutils.parsers.rst.directives import choice, unchanged
+from docutils.statemachine import ViewList
+
+import jinja2
+from sphinx.util.compat import Directive
+from sphinx.util.nodes import nested_parse_with_titles
+
+from .utils import out_of_date
+
+CODE_TEMPLATE = jinja2.Template("""
+.. code-block:: python
+    :linenos:
+
+    {{ code|indent(4)}}
+""")
+
+PLOT_TEMPLATE = jinja2.Template("""
+.. raw:: html
+
+    <table>
+      <tr>
+        <td>
+        {{ plot|indent(8) }}
+        </td>
+      </tr>
+    </table>
+""")
+
+
+def _source_position(argument):
+    return choice(argument, ('below', 'above', 'none'))
+
+
+class BokehPlotDirective(Directive):
+
+    has_content = True
+
+    option_spec = {
+        'basedir'         : unchanged,
+        'source-position' : _source_position,
+    }
+
+    def run(self):
+
+        # filename *or* python code content, but not both
+        if self.arguments and self.content:
+            raise RuntimeError("bokeh-plot:: directive can't have both args and content")
+
+        self.result = ViewList()
+
+        env = self.state.document.settings.env
+
+        target_id = "bokeh-plot-%d" % env.new_serialno('bokeh-plot')
+        target_node = nodes.target('', '', ids=[target_id])
+
+        source_position = self.options.get('source-position', 'below')
+
+        if source_position is 'above':
+            self._add_source()
+
+        self._add_plot()
+
+        if source_position is 'below':
+            self._add_source()
+
+        node = nodes.paragraph()
+        node.document = self.state.document
+        self.state.nested_parse(self.result, 0, node)
+
+        return [target_node] + node.children
+
+
+    def _add_source(self):
+        # TODO: (bev) extract actual source code
+        text = CODE_TEMPLATE.render(code="import foo")
+        for line in text.split("\n"):
+            self.result.append(line, "<bokeh-plot>")
+
+
+    def _add_plot(self):
+        # TODO: (bev) run source code and create plot embed snippet
+        text = PLOT_TEMPLATE.render(plot="FOO")
+        for line in text.split("\n"):
+            self.result.append(line, "<bokeh-plot>")
+
+
+def setup(app):
+    app.add_directive('bokeh-plot', BokehPlotDirective)
+
+
+
+
+
+

bokeh/sphinxext/utils.py

@@ -0,0 +1,27 @@
+
+import os
+from os.path import exists
+
+def out_of_date(original, derived):
+    """ Test whether a derived file is newer than its original.
+
+    Args:
+        original (str) : full path to original file
+        derived (str) : full path to derived file
+
+    Returns:
+        bool :
+            True if original is newer or derived does not
+            exist, False otherwise
+
+    Raises:
+        RuntimeError : if original does not exists
+
+    """
+    if not exists(original):
+        raise RuntimeError()
+
+    if not exists(derived):
+        return True
+
+    return os.stat(derived).st_mtime < os.stat(original).st_mtime