shapes examples

experiments with deserialization
annotations
ndarray support for Histogram - removed plotly_orca
extending ndarray support

Author: Ioannis Giagkiozis

.github/workflows/release_ci.yml

@@ -18,7 +18,7 @@ jobs:
     - name: build_linux
       run: cargo build --all-features --verbose
     - name: Run tests
-      run: cargo test --workspace --exclude plotly_orca --verbose
+      run: cargo test --workspace --verbose
 
   build_windows:
     runs-on: windows-latest
@@ -28,7 +28,7 @@ jobs:
       - name: build_windows
         run: cargo build --all-features --verbose
       - name: Run tests
-        run: cargo test --workspace --exclude plotly_orca --verbose
+        run: cargo test --workspace --verbose
 
   build_macos:
     runs-on: macos-latest
@@ -38,4 +38,4 @@ jobs:
       - name: build_macos
         run: cargo build --all-features --verbose
       - name: Run tests
-        run: cargo test --workspace --exclude plotly_orca --verbose
+        run: cargo test --workspace --verbose

CHANGELOG.md

@@ -7,10 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [0.6.0] - 2020-xx-xx
 ### Added
-- prelude
-- Shapes support.
+- Shapes support (TODO add link to documentation and examples).
+- Annotations support (TODO add link to documentation and examples).
+- Docstrings.
+- `ndarray` support (TODO add link to documentation and examples).
 ### Changed
-- xx
+- Removed `num` dependence.
+- Removed `plotly_orca` and the `orca` feature. Use the `kaleido` feature for static image generation.
+- Updated Kaleido version in `plotly_kaleido` to 0.0.1.
 ### Fixed
 - xx
 

Cargo.toml

@@ -1,7 +1,6 @@
 [workspace]
 members = [
     "plotly",
-    "plotly_orca",
     "plotly_kaleido",
     "plotly_ndarray"
 ]

README.md

@@ -28,7 +28,6 @@
     <a href="">
         <img src="https://img.shields.io/badge/Minimum%20Rust%20Version-1.31-brightgreen.svg" alt="Minimum Version">
     </a>
-
 </div>
 
 A plotting library for Rust powered by [Plotly.js](https://plot.ly/javascript/).
@@ -40,7 +39,7 @@ Add this to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-plotly = "0.5.1"
+plotly = "0.6.0"
 ```
 
 For changes since the last version please consult the [change log](https://github.com/igiagkiozis/plotly/blob/master/CHANGELOG.md).
@@ -51,13 +50,15 @@ The following feature flags are available:
     * Optional, compatible with Rust stable.
     * Adds plot save functionality to the following formats: png, jpeg, webp, svg, pdf and eps.
     * Requires some additional configuration, see [plotly_kaleido](https://github.com/igiagkiozis/plotly/tree/master/plotly_kaleido).
-* `orca` - This feature is **deprecated**, please use `kaleido` instead.
+* `ndarray`
+    * Optional, compatible with Rust stable.
+    * Adds support for creating plots directly using [ndarray](https://github.com/rust-ndarray/ndarray) types.
 
 Saving to png, jpeg, webp, svg, pdf and eps formats can be made available by enabling the `kaleido` feature: 
 
 ```toml
 [dependencies]
-plotly = { version = "0.5.1", features = ["kaleido"] }
+plotly = { version = "0.6.0", features = ["kaleido"] }
 ```
 For further details please see [plotly_kaleido](https://github.com/igiagkiozis/plotly/tree/master/plotly_kaleido).
 

docs/book/book.toml

@@ -17,5 +17,5 @@ additional-js = ["ferris.js", "plotly-1.54.6.min.js"]
 
 
 [output.html.fold]
-enable = false
-level = 0
+enable = true
+level = 1

docs/book/src/SUMMARY.md

@@ -2,7 +2,16 @@
 
 - [Plotly.rs](./plotly_rs.md)
     - [Getting Started](./getting_started.md)
+- [Fundamentals](./fundamentals.md)
+    - [`ndarray` Support](./fundamentals/ndarray_support.md)
 - [Recipes](./recipes.md)
+    - [Fundamentals](./recipes/fundamentals.md)
+        - [Axes](./recipes/fundamentals/axes.md)
+        - [Interactive HTML Export](./recipes/fundamentals/interactive_html_export.md)
+        - [Legends](./recipes/fundamentals/legends.md)
+        - [Shapes](./recipes/fundamentals/shapes.md)
+        - [Static Image Export](./recipes/fundamentals/static_image_export.md)
+        - [Styling Markers](./recipes/fundamentals/styling_markers.md)
     - [Basic Charts](./recipes/basic_charts.md)
         - [Scatter Plots](./recipes/basic_charts/scatter_plots.md)
         - [Line Charts](./recipes/basic_charts/line_charts.md)

docs/book/src/fundamentals.md

@@ -0,0 +1 @@
+# Fundamentals

docs/book/src/fundamentals/ndarray_support.md

@@ -0,0 +1 @@
+# `ndarray` Support 

docs/book/src/getting_started.md

@@ -1,23 +1,40 @@
 # Getting Started
-
-To start using `Plotly.rs` in your project add the following to your `Cargo.toml`:
+<div align="center">
+    <a href="https://github.com/igiagkiozis/plotly/tree/master">
+        <img src="https://img.shields.io/badge/Plotly.rs-master-brightgreen" alt="build status">
+    </a>
+    <a href="https://github.com/igiagkiozis/plotly/actions">
+        <img src="https://github.com/igiagkiozis/plotly/workflows/build/badge.svg" alt="build status">
+    </a>
+    <a href="https://crates.io/crates/plotly">
+        <img src="https://img.shields.io/crates/v/plotly.svg" alt="Crates.io">
+    </a>
+	<a href="https://docs.rs/plotly">
+        <img src="https://docs.rs/plotly/badge.svg" alt="Documentation">
+    </a>
+    <a href="">
+        <img src="https://img.shields.io/badge/Minimum%20Rust%20Version-1.31-brightgreen.svg" alt="Minimum Version">
+    </a>
+</div>
+
+To start using [Plotly.rs](https://github.com/igiagkiozis/plotly) in your project add the following to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-plotly = "0.5.1"
+plotly = "0.6.0"
 ```
 
-To add the ability to save plots in the following formats: png, jpeg, webp, svg, pdf and eps, you can use the `kaleido` feature. This feature depends on [plotly/Kaleido](https://github.com/plotly/Kaleido); a cross-platform library for generating static images. All the necessary binaries have been included with `plotly_kaleido` for `linux`, `windows` and `macos`. Previous versions of `Plotly.rs` used the `orca` feature; however this has been deprecated as it provided the same functionality but required additional installation steps. To enable the `kaleido` feature add the following to your `Cargo.toml` instead: 
+To add the ability to save plots in the following formats: png, jpeg, webp, svg, pdf and eps, you can use the `kaleido` feature. This feature depends on [plotly/Kaleido](https://github.com/plotly/Kaleido); a cross-platform library for generating static images. All the necessary binaries have been included with `plotly_kaleido` for `linux`, `windows` and `macos`. Previous versions of [Plotly.rs](https://github.com/igiagkiozis/plotly) used the `orca` feature; however this has been deprecated as it provided the same functionality but required additional installation steps. To enable the `kaleido` feature add the following to your `Cargo.toml` instead: 
 
 ```toml
 [dependencies]
-plotly = { version = "0.5.1", features = ["kaleido"] }
+plotly = { version = "0.6.0", features = ["kaleido"] }
 ```
 
 Plotly Kaleido is an open source project 
 
 
-`Plotly.rs` has three main components: 
+[Plotly.rs](https://github.com/igiagkiozis/plotly) has three main components: 
 
 - Traces; these are containers for the data for display,
 - Layout, fine tunes the display of traces on the canvas and more generally controls the way that the plot is displayed, and,

docs/book/src/plotly_rs.md

@@ -1,4 +1,21 @@
 # Plotly.rs
+<div align="center">
+    <a href="https://github.com/igiagkiozis/plotly/tree/master">
+        <img src="https://img.shields.io/badge/Plotly.rs-master-brightgreen" alt="build status">
+    </a>
+    <a href="https://github.com/igiagkiozis/plotly/actions">
+        <img src="https://github.com/igiagkiozis/plotly/workflows/build/badge.svg" alt="build status">
+    </a>
+    <a href="https://crates.io/crates/plotly">
+        <img src="https://img.shields.io/crates/v/plotly.svg" alt="Crates.io">
+    </a>
+	<a href="https://docs.rs/plotly">
+        <img src="https://docs.rs/plotly/badge.svg" alt="Documentation">
+    </a>
+    <a href="">
+        <img src="https://img.shields.io/badge/Minimum%20Rust%20Version-1.31-brightgreen.svg" alt="Minimum Version">
+    </a>
+</div>
 
 Plotly.rs is a plotting library powered by [Plotly.js](https://plot.ly/javascript/). The aim is to bring over to Rust all the functionality that `Python` users have come to rely on; with the added benefit of type safety and speed.