Skip to content

Commit c3b302c

Browse files
committed
Add release notes and features pages to the documentation.
1 parent ad3782b commit c3b302c

File tree

4 files changed

+53
-13
lines changed

4 files changed

+53
-13
lines changed

docs/ethos.rst

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,11 @@
77
The Toyplot Ethos
88
=================
99

10-
What began as a quick workaround to reduce the size of animations in IPython
11-
quickly grew into Toyplot, "the kid-sized plotting toolkit with grownup-sized
12-
goals". In a nutshell, we think that scientists and engineers should expect
13-
more from their plots: more interaction, more reproducibility, greater clarity,
14-
and better aesthetics.
10+
What began as a quick workaround to reduce the size of animated figures in
11+
IPython quickly grew into Toyplot, "the kid-sized plotting toolkit with
12+
grownup-sized goals". In a nutshell, we think that scientists and engineers
13+
should expect more from their plots, including: explicit support for
14+
reproducibility and open science, greater clarity, and better aesthetics.
1515

1616
We especially feel that, in an age of ubiquitous electronic media and the web,
1717
it makes little sense to publish using media (such as PDF) designed to mimic
@@ -20,16 +20,16 @@ HTML, and Javascript - as its primary medium, so we can make useful new
2020
interactions part of the everyday experiences of data graphic users. Because
2121
we're passionate about publishing and sharing results, Toyplot graphics are
2222
completely self-contained and embeddable, without the need for a server. All
23-
of the Toyplot graphics you see in these pages are live and interactive,
24-
despite the fact that they were created offline in an IPython notebook and
25-
passed through several publishing steps on the way to becoming our
26-
documentation. Of course, we provide backends to publish Toyplot figures
27-
to legacy formats including PNG, PDF, Encapsulated Postscript, and MP4.
23+
of the Toyplot graphics you will see in this documentation are live and
24+
interactive, despite the fact that they were created offline in an IPython
25+
notebook and passed through several publishing steps on the way to becoming our
26+
documentation. Of course, we provide backends to publish Toyplot figures to
27+
legacy formats including PNG, PDF, Encapsulated Postscript, and MP4.
2828

2929
Interactivity includes obvious things such as zooming and panning. But beyond
30-
that, Toyplot is exploring ideas from efficient animation that doesn't impact
31-
the quality of the graphic to interactive data cursors that display quantities
32-
of interest and descriptive statistics by pointing at the figure. And since
30+
that, Toyplot is exploring ideas including efficient animation that doesn't impact
31+
the quality of the graphic, and interactive data cursors that display quantities
32+
of interest and descriptive statistics just by hovering the mouse. And since
3333
the raw data is already implicitly embedded in a graphic, why not support
3434
reproducibility by making it easy to export, so the viewer can work with it
3535
themselves? That's why Toyplot has a context menu to export raw data from a

docs/features.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
.. _Features:
2+
3+
.. image:: ../artwork/toyplot.png
4+
:width: 300px
5+
:align: right
6+
7+
Toyplot Features
8+
================
9+
10+
* Plot types: bar plots, filled region plots, line plots, scatter plots, rectangle plots, text plots.
11+
* Styling: all plot elements stylable using CSS.
12+
* Integrates with IPython without any need for plugins, magics, etc.
13+
* Interaction types: display interactive mouse coordinates, export figure data to CSV.
14+
* Interactive output formats: Embeddable, self-contained HTML+SVG+Javascript.
15+
* Static output formats: SVG, PNG, PDF, EPS, MP4.
16+
* Portability: common code base for Python 2.7 / Python 3.4.
17+
* Testing: greater-than-95% regression test coverage.
18+

docs/index.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,14 @@ Documentation
2424
.. toctree::
2525
:maxdepth: 2
2626

27+
features.rst
2728
ethos.rst
2829
dependencies.rst
2930
installation.rst
3031
tutorial.rst
3132
user-guide.rst
3233
contributing.rst
34+
release-notes.rst
3335
reference.rst
3436
contacts.rst
3537

docs/release-notes.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
.. _Release Notes:
2+
3+
.. image:: ../artwork/toyplot.png
4+
:width: 200px
5+
:align: right
6+
7+
Release Notes
8+
=============
9+
10+
Toyplot 0.2.0 - September 2, 2014
11+
---------------------------------
12+
13+
* Introduced support for Python 3.
14+
* Removed pure black from the default styling.
15+
* Allow regression tests to run without optional dependencies.
16+
17+
Toyplot 0.1.0 - August 25, 2014
18+
-------------------------------
19+
20+
* Initial Release

0 commit comments

Comments
 (0)