Source

sphinx-contrib / googlechart / README

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
googlechart extension README
============================

This is a sphinx extension which render charts and graphs by using
`Google Chart <http://code.google.com/intl/ja/apis/chart/>`_ .

source:

.. code-block:: text

   .. piechart::

      dog: 100
      cat: 80
      rabbit: 40

rendered:

.. piechart::

   dog: 100
   cat: 80
   rabbit: 40

Setting
=======

You can see available package at `PyPI <http://pypi.python.org/pypi/sphinxcontrib-googlechart>`_.

You can get source code at http://bitbucket.org/birkenfeld/sphinx-contrib/

Install
-------

.. code-block:: bash

   $ easy_install sphinxcontrib-googlechart


Configure Sphinx
----------------

To enable this extension, add ``sphinxcontrib.googlechart`` module to extensions 
option at :file:`conf.py`. 

.. code-block:: python

   # Enabled extensions
   extensions = ['sphinxcontrib.googlechart']


Directive
=========

.. describe:: .. piechart::

   This directive insert a piechart into the generated document.
   piechart directive takes code block as source script.

   Examples::

      .. piechart::

         dog: 100
         cat: 80
         rabbit: 40

   .. piechart::

      dog: 100
      cat: 80
      rabbit: 40

   If you want to change colors of chart,
   write color parameters at source script::

      .. piechart::

         dog: 100
         dog.color: ff0000
         cat: 80
         cat.color: 00ff00
         rabbit: 40
         rabbit.color: 0000ff

   .. piechart::

      dog: 100
      dog.color: ff0000
      cat: 80
      cat.color: 00ff00
      rabbit: 40
      rabbit.color: 0000ff


.. describe:: .. piechart3d::

   This directive insert a 3D piechart into the generated document.
   piechart directive takes code block as source script.

   Examples::

      .. piechart3d::
         :size: 480x240

         dog: 100
         cat: 80
         rabbit: 40

   .. piechart3d::
      :size: 480x240

      dog: 100
      cat: 80
      rabbit: 40


.. describe:: .. linechart::

   This directive insert a linechart into the generated document.
   linechart directive takes code block as source script.

   Examples::

      .. linechart::

         bicycle: 15, 35, 20, 40
         car: 60, 75, 60, 30

   .. linechart::

      bicycle: 15, 35, 20, 40
      car: 60, 75, 60, 30

   If you want to change colors of chart,
   write color parameters at source script::

      .. linechart::

         bicycle: 15, 35, 20, 40
         bicycle.color: ff0000
         car: 60, 75, 60, 30
         car.color: 0000ff

   .. linechart::

      bicycle: 15, 35, 20, 40
      bicycle.color: ff0000
      car: 60, 75, 60, 30
      car.color: 0000ff

   If you want to append axis to chart,
   write axis and axis_label parameters at source script::

      .. linechart::

         bicycle: 15, 35, 20, 40
         bicycle.color: ff0000
         bicycle.axis: x
         bicycle.axis_label: slow, fast
         car: 60, 75, 60, 30
         car.color: 0000ff

   .. linechart::

      bicycle: 15, 35, 20, 40
      bicycle.color: ff0000
      bicycle.axis: x
      bicycle.axis_label: slow, fast
      car: 60, 75, 60, 30
      car.color: 0000ff

   If you want to change colors of chart,
   write color parameters at source script::

      .. linechart::

         bicycle: 15, 35, 20, 40
         bicycle.color: ff0000
         car: 60, 75, 60, 30
         car.color: 0000ff

   .. linechart::

      bicycle: 15, 35, 20, 40
      bicycle.color: ff0000
      car: 60, 75, 60, 30
      car.color: 0000ff


.. describe:: .. linechartxy::

   This directive insert a linechart into the generated document.
   linechart directive takes code block as source script.

   Examples::

      .. linechartxy::

         bicycle: (0, 15), (30, 35), (60, 20), (90, 40)
         car: (0, 60), (20, 75), (40, 60), (90, 30)


   .. linechartxy::

      bicycle: (0, 15), (30, 35), (60, 20), (90, 40)
      car: (0, 60), (20, 75), (40, 60), (90, 30)


.. describe:: .. holizontal_barchart::

   This directive insert a barchart into the generated document.
   barchart directive takes code block as source script.

   Examples::

      .. holizontal_barchart::

         bicycle: 15, 25, 20, 30
         bicycle.color: ff0000
         bicycle.axis: x
         bicycle.axis_label: slow, fast
         car: 40, 50, 60, 45
         car.color: 0000ff

   .. holizontal_barchart::

      bicycle: 15, 25, 20, 30
      bicycle.color: ff0000
      bicycle.axis: x
      bicycle.axis_label: slow, fast
      car: 40, 50, 60, 45
      car.color: 0000ff


.. describe:: .. vertical_barchart::

   This directive insert a barchart into the generated document.
   barchart directive takes code block as source script.

   Examples::

      .. vertical_barchart::

         bicycle: 15, 25, 20, 30
         bicycle.color: ff0000
         bicycle.axis: y
         bicycle.axis_label: slow, fast
         car: 40, 50, 60, 45
         car.color: 0000ff

   .. vertical_barchart::

      bicycle: 15, 25, 20, 30
      bicycle.color: ff0000
      bicycle.axis: y
      bicycle.axis_label: slow, fast
      car: 40, 50, 60, 45
      car.color: 0000ff


.. describe:: .. holizontal_bargraph::

   This directive insert a barchart into the generated document.
   barchart directive takes code block as source script.

   Examples::

      .. holizontal_bargraph::

         bicycle: 15, 25, 20, 30
         bicycle.color: ff0000
         bicycle.axis: x
         bicycle.axis_label: slow, fast
         car: 40, 50, 60, 45
         car.color: 0000ff

   .. holizontal_bargraph::

      bicycle: 15, 25, 20, 30
      bicycle.color: ff0000
      bicycle.axis: x
      bicycle.axis_label: slow, fast
      car: 40, 50, 60, 45
      car.color: 0000ff


.. describe:: .. vertical_bargraph::

   This directive insert a barchart into the generated document.
   barchart directive takes code block as source script.

   Examples::

      .. vertical_bargraph::

         bicycle: 15, 25, 20, 30
         bicycle.color: ff0000
         bicycle.axis: y
         bicycle.axis_label: slow, fast
         car: 40, 50, 60, 45
         car.color: 0000ff

   .. vertical_bargraph::

      bicycle: 15, 25, 20, 30
      bicycle.color: ff0000
      bicycle.axis: y
      bicycle.axis_label: slow, fast
      car: 40, 50, 60, 45
      car.color: 0000ff


.. describe:: .. venndiagram::

   This directive insert a venn diagrams into the generated document.
   venndiagram directive takes code block as source script.

   Examples::

      .. venndiagram::

         data: 100, 80, 40, 20, 20, 20, 10

   .. venndiagram::

      data: 100, 80, 40, 20, 20, 20, 10


.. describe:: .. plotchart::

   This directive insert a plotchart into the generated document.
   plotchart directive takes code block as source script.

   Examples::

      .. plotchart::

         data: (50, 60), (75, 20), (20, 30), (10, 70), (45, 10)

   .. plotchart::

      data: (50, 60), (75, 20), (20, 30), (10, 70), (45, 10)
      data.axis: x, y
      data.axis_label: (slow, fast), (low, high)


Graphviz charts on Google Chart
===============================

You can use Google Chart for graphviz chart generation.
``sphinxcontrib.googlechart.graphviz`` module is compatible with ``sphinx.ext.graphviz`` .
This module does not depend to `graphviz` binaries.

If you want to use graphviz for Google Chart` ,
add ``sphinxcontrib.googlechart.graphviz`` module to extention option.

.. code-block:: python

   # Enabled extensions
   extensions = ['sphinxcontrib.googlechart', 'sphinxcontrib.googlechart.graphviz']

.. describe:: .. graphviz:: [filename]

   This directive insert a graphviz graph into the generated document.
   graphviz directive takes filename argument or code block as source script.

   Examples::

      .. graphviz:: external.dot

      .. graphviz::

         digraph {
           A -> B;
         }

   .. graphviz::

      digraph {
        A -> B;
      }

.. describe:: .. graph:: [graph_id]

   This directive insert a graphviz graph into the generated document.
   graph directive takes graph_id argument and code block as source script.

   Examples::

      .. graph::

         A -- B;

   .. graph::

      A -- B;

.. describe:: .. digraph:: [graph_id]

   This directive insert a graphviz digraph into the generated document.
   digraph directive takes graph_id argument and code block as source script.

   Examples::

      .. digraph::

         A -- B;

   .. digraph::

      A -> B;


Repository
==========

This code is hosted by Bitbucket.

  http://bitbucket.org/birkenfeld/sphinx-contrib/