further integration of pyexcel-chart with sphinx

Author: chfw

docs/source/conf.py

@@ -1,7 +1,6 @@
 # -*- coding: utf-8 -*-
 import os
 import sys
-import pdb;pdb.set_trace()
 sys.path.append(os.path.abspath('.'))
 extensions = [
     'sphinx.ext.autodoc',

docs/source/pyexcel_sphinx_integration.py

@@ -41,23 +41,11 @@
 class PygalDirective(Directive):
     """Execute the given python file and puts its result in the document."""
     required_arguments = 0
-    optional_arguments = 2
     final_argument_whitespace = True
     has_content = True
 
     def run(self):
-        width, height = map(int, self.arguments[:2]) if len(
-            self.arguments) >= 2 else (600, 400)
-        if len(self.arguments) == 1:
-            self.render_fix = bool(self.arguments[0])
-        elif len(self.arguments) == 3:
-            self.render_fix = bool(self.arguments[2])
-        else:
-            self.render_fix = False
-        self.content = list(self.content)
         content = list(self.content)
-        if self.render_fix:
-            content[-1] = 'rv = ' + content[-1]
         code = '\n'.join(content)
         scope = {'pyexcel': pyexcel}
         try:
@@ -69,19 +57,16 @@ def run(self):
                 'An exception as occured during code parsing:'
                 ' \n %s' % format_exc(), type='ERROR', source='/',
                 level=3)]
-        if self.render_fix:
-            rv = scope['rv']
-        else:
-            chart = None
-            for key, value in scope.items():
-                if isinstance(value, BytesIO):
-                    chart = value
-                    #self.content.append(key + '.render()')
-                    break
-            if chart is None:
-                return [docutils.nodes.system_message(
-                    'No instance of graph found', level=3,
-                    type='ERROR', source='/')]
+        chart = None
+        for key, value in scope.items():
+            if isinstance(value, BytesIO):
+                chart = value
+                #self.content.append(key + '.render()')
+                break
+        if chart is None:
+            return [docutils.nodes.system_message(
+                'No instance of graph found', level=3,
+                type='ERROR', source='/')]
 
         try:
             svg = "%s" % chart.getvalue().decode('utf-8')

docs/source/usage.rst

@@ -1,7 +1,7 @@
 Usage
 ================================================================================
 
-There are currently four type of data layouts for rendering charts. 
+There are currently four type of data layouts for rendering charts.
 
 1 Simple Layout
 --------------------------------------------------------------------------------
@@ -14,7 +14,7 @@ Pie chart
 .. csv-table::
    :file: ../../pie.csv
 
-		   
+
 Here is the source code using pyexcel
 
 .. pyexcel-code::
@@ -36,13 +36,15 @@ Box chart
 .. image:: _static/pbox.svg
    :width: 600px
    :height: 400px
-		   
-Here is the source code using pyexcel::
 
-    >>> import pyexcel as p
-    >>> title = 'V8 benchmark results'	
-    >>> p.save_as(file_name='box.csv', dest_chart_type='box',
-    ...     dest_file_name='pbox.svg', dest_title=title)
+Here is the source code using pyexcel:
+
+.. pyexcel-code::
+
+    title = 'V8 benchmark results'
+    sheet = pyexcel.get_sheet(file_name='box.csv')
+    svg = sheet.plot(chart_type='box',
+         title=title, width=600, height=400, explicit_size=True)
 
 2 Complex layout
 --------------------------------------------------------------------------------
@@ -58,50 +60,43 @@ Line
 .. csv-table::
    :file: ../../line.csv
 
-.. image:: _static/pline.svg
-   :width: 600px
-   :height: 400px
-		   
-Here is the source code using pyexcel::
+Here is the source code using pyexcel:
+
+.. pyexcel-code::
 
-    >>> import pyexcel as p
-    >>> title = 'Browser usage evolution (in %)'
-    >>> p.save_as(file_name='line.csv', dest_chart_type='line',
-    ...     dest_file_name='pline.svg', dest_title=title)
+    title = 'Browser usage evolution (in %)'
+    sheet = pyexcel.get_sheet(file_name='line.csv')
+    svg = sheet.plot(chart_type='line',
+        title=title, width=600, height=400, explicit_size=True)
 
 Dot chart
 ********************************************************************************
 
 .. csv-table::
    :file: ../../radar.csv
 
-.. image:: _static/pdot.svg
-   :width: 600px
-   :height: 400px
+Here is the source code using pyexcel:
 
-Here is the source code using pyexcel::
+.. pyexcel-code::
 
-    >>> import pyexcel as p
-    >>> title = 'V8 benchmark results'	
-    >>> p.save_as(file_name='radar.csv', dest_chart_type='dot',
-    ...     dest_file_name='pdot.svg', dest_title=title)
+    title = 'V8 benchmark results'
+    sheet = pyexcel.get_sheet(file_name='radar.csv')
+    svg = sheet.plot(chart_type='dot',
+        title=title, width=600, height=400, explicit_size=True)
 
 Funnel chart
 ********************************************************************************
 
 .. csv-table::
    :file: ../../funnel.csv
 
-.. image:: _static/pfunnel.svg
-   :width: 600px
-   :height: 400px
-		   
+
 Here is the source code using pyexcel::
 
-    >>> import pyexcel as p
-    >>> title = 'V8 benchmark results'	
-    >>> p.save_as(file_name='funnel.csv', dest_chart_type='funnel',
-    ...     dest_file_name='pfunnel.svg', dest_title=title)
+    title = 'V8 benchmark results'
+    sheet = p.get_sheet(file_name='funnel.csv')
+    svg = sheet.plot(chart_type='funnel',
+        title=title, width=600, height=400, explicit_size=True)
 
 Radar chart
 ********************************************************************************
@@ -111,16 +106,14 @@ Radar chart
    :file: ../../radar.csv
 
 
-.. image:: _static/pradar.svg
-   :width: 600px
-   :height: 400px
-		   
 Here is the source code using pyexcel::
 
-    >>> import pyexcel as p
-    >>> title = 'V8 benchmark results'	
-    >>> p.save_as(file_name='radar.csv', dest_chart_type='radar',
-    ...     dest_file_name='pradar.svg', dest_title=title)
+.. pyexcel-code::
+
+    title = 'V8 benchmark results'
+    sheet = pyexcel.get_sheet(file_name='radar.csv')
+    svg = sheet.plot(chart_type='radar',
+        title=title, width=600, height=400, explicit_size=True)
 
 Histogram
 --------------------------------------------------------------------------------
@@ -131,15 +124,14 @@ in first, second and third columns.
 .. csv-table::
    :file: ../../histogram_wide_bars.csv
 
-.. image:: _static/phistogram_wide_bars.svg
-   :width: 600px
-   :height: 400px
-		   
-Here is the source code using pyexcel::
 
-    >>> import pyexcel as p
-    >>> p.save_as(file_name='histogram_wide_bars.csv', dest_chart_type='histogram',
-    ...     dest_file_name='phistogram_wide_bars.svg')
+Here is the source code using pyexcel:
+
+.. pyexcel-code::
+
+    sheet = pyexcel.get_sheet(file_name='histogram_wide_bars.csv')
+    svg = sheet.plot(chart_type='histogram',
+         width=600, height=400, explicit_size=True)
 
 
 In order to draw multiple histogram on the same chart, you will need to use a
@@ -148,12 +140,15 @@ Book, each sheet of which become a histogram. Here is how you can draw multiple
 .. image:: _static/phistogram.svg
    :width: 600px
    :height: 400px
-		   
-Here is the source code using pyexcel::
 
-    >>> import pyexcel as p
-    >>> p.save_book_as(file_name='histogram.xlsx', dest_chart_type='histogram',
-    ...     dest_file_name='phistogram.svg')
+Here is the source code using pyexcel
+
+
+.. pyexcel-code::
+
+    book = pyexcel.get_book(file_name='histogram.xlsx')
+    svg = book.plot(chart_type='histogram',
+         width=600, height=400, explicit_size=True)
 
 XY
 --------------------------------------------------------------------------------
@@ -165,12 +160,11 @@ in individual sheets.
 .. csv-table::
    :file: ../../radar.csv
 
-.. image:: _static/pxy.svg
-   :width: 600px
-   :height: 400px
-		   
-Here is the source code using pyexcel::
 
-    >>> import pyexcel as p
-    >>> p.save_book_as(file_name='xy.xlsx', dest_chart_type='xy',
-    ...     dest_file_name='pxy.svg')
+Here is the source code using pyexcel
+
+.. pyexcel-code::
+
+    book = pyexcel.get_book(file_name='xy.xlsx')
+    svg = book.plot(chart_type='xy',
+         width=600, height=400, explicit_size=True)