simplecharts

commit

e7cec1c8164b230ab01010f32a4730eb730fe505

parent

344702fcd34d535508935887bd001961cce9ec76

Author

Tobias Bengfort <tobias.bengfort@posteo.de>

Date

2019-10-02 10:47

convert docs to rst

Diffstat

3 files changed, 27 insertions, 26 deletions

diff --git a/CHANGES.md b/CHANGES.rst

@@ -1,8 +1,7 @@
    1     1 0.0.2 (2019-10-02)
    2     2 ------------------
    3     3 
    4    -1 -   add aria-attributes for better accessibility
    5    -1 
   -1     4 -  add aria-attributes for better accessibility
    6     5 
    7     6 0.0.1 (2019-02-20)
    8     7 ------------------

diff --git a/README.md b/README.rst

@@ -1,30 +1,32 @@
    1    -1 # Features
   -1     1 Features
   -1     2 ========
    2     3 
    3     4 -   no big dependencies
    4     5 -   produces clean SVG
    5     6 -   available charts: grouped columns, stacked columns, lines, stacked areas
    6     7 
    7    -1 # Usage
   -1     8 Usage
   -1     9 =====
    8    10 
    9    -1 ```python
   10    -1 renderer = StackedColumnRenderer()
   11    -1 data = {
   12    -1     'rows': [{
   13    -1         'label': 'Apples',
   14    -1         'values': [3, 2, 5],
   15    -1     }, {
   16    -1         'label': 'Oranges',
   17    -1         'values': [4, 2, 3],
   18    -1     }, {
   19    -1         'label': 'Pears',
   20    -1         'values': [4, 3, 4],
   21    -1     }, {
   22    -1         'label': 'Bananas',
   23    -1         'values': [5, 1, 2],
   24    -1     }],
   25    -1     'legend': ['John', 'Jane', 'Joe'],
   26    -1 }
   27    -1 svg = renderer.render(data)
   28    -1 ```
   -1    11 .. code:: python
   29    12 
   30    -1 ![example](https://github.com/xi/simplecharts/blob/master/tests/simple_StackedColumnRenderer.svg)
   -1    13     renderer = StackedColumnRenderer()
   -1    14     data = {
   -1    15         'rows': [{
   -1    16             'label': 'Apples',
   -1    17             'values': [3, 2, 5],
   -1    18         }, {
   -1    19             'label': 'Oranges',
   -1    20             'values': [4, 2, 3],
   -1    21         }, {
   -1    22             'label': 'Pears',
   -1    23             'values': [4, 3, 4],
   -1    24         }, {
   -1    25             'label': 'Bananas',
   -1    26             'values': [5, 1, 2],
   -1    27         }],
   -1    28         'legend': ['John', 'Jane', 'Joe'],
   -1    29     }
   -1    30     svg = renderer.render(data)
   -1    31 
   -1    32 .. figure:: https://github.com/xi/simplecharts/blob/master/tests/simple_StackedColumnRenderer.svg

diff --git a/setup.py b/setup.py

@@ -2,7 +2,7 @@ import os
    2     2 
    3     3 from setuptools import setup
    4     4 
    5    -1 README = open(os.path.join(os.path.dirname(__file__), 'README.md')).read()
   -1     5 README = open(os.path.join(os.path.dirname(__file__), 'README.rst')).read()
    6     6 
    7     7 
    8     8 setup(