fix book examples (#233)

Closes #223

Signed-off-by: Andrei Gherghescu <[email protected]>

Author: andrei-ng

CHANGELOG.md

@@ -3,6 +3,15 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.9.1] - 2024-09-06
+### Added
+- [[#217](https://github.com/plotly/plotly.rs/pull/217)] Added show_html(filename) method to bypass situations where accessing default `/tmp` is not possible, e.g., with in SNAP Firefox
+- [[#227](https://github.com/plotly/plotly.rs/pull/227)] Switch from HTML template render from `askama` to `rinja`
+
+### Fixed
+- [[#232](https://github.com/plotly/plotly.rs/pull/232)] Generalize OS detection in the context of opening HTML pages with default app via `xdg-open`
+- [[#233](https://github.com/plotly/plotly.rs/pull/233)] Fix mdBook code examples
+
 ## [0.9.0] - 2024-06-29
 ### Added
 - [[#153](https://github.com/plotly/plotly.rs/pull/153)] Added `LayoutScene`.

docs/book/src/fundamentals/shapes.md

@@ -11,7 +11,7 @@ use plotly::layout::{
     Axis, GridPattern, Layout, LayoutGrid, Margin, Shape, ShapeLayer, ShapeLine,
     ShapeType,
 };
-use plotly::{Bar, NamedColor, Plot, Scatter};
+use plotly::{Bar, color::NamedColor, Plot, Scatter};
 use rand::thread_rng;
 use rand_distr::{Distribution, Normal};
 ```

docs/book/src/recipes/basic_charts/bar_charts.md

@@ -8,15 +8,15 @@ use plotly::common::{
     ColorScale, ColorScalePalette, DashType, Fill, Font, Line, LineShape, Marker, Mode, Title,
 };
 use plotly::layout::{Axis, BarMode, Layout, Legend, TicksDirection};
-use plotly::{Bar, NamedColor, Plot, Rgb, Rgba, Scatter};
+use plotly::{Bar, color::{NamedColor, Rgb, Rgba}, Plot, Scatter};
 use rand_distr::{Distribution, Normal, Uniform};
 ```
 
 The `to_inline_html` method is used to produce the html plot displayed in this page.
 
 
 ## Basic Bar Chart
-```rust 
+```rust
 fn basic_bar_chart(show: bool) {
     let animals = vec!["giraffes", "orangutans", "monkeys"];
     let t = Bar::new(animals, vec![20, 14, 23]);
@@ -43,7 +43,7 @@ var layout = {};
 </script>
 
 ## Grouped Bar Chart
-```rust 
+```rust
 fn grouped_bar_chart(show: bool) {
     let animals1 = vec!["giraffes", "orangutans", "monkeys"];
     let trace1 = Bar::new(animals1, vec![20, 14, 23]).name("SF Zoo");
@@ -79,7 +79,7 @@ var layout = {"barmode":"group"};
 
 
 ## Stacked Bar Chart
-```rust 
+```rust
 fn stacked_bar_chart(show: bool) {
     let animals1 = vec!["giraffes", "orangutans", "monkeys"];
     let trace1 = Bar::new(animals1, vec![20, 14, 23]).name("SF Zoo");

docs/book/src/recipes/basic_charts/line_charts.md

@@ -8,7 +8,7 @@ use plotly::common::{
     ColorScale, ColorScalePalette, DashType, Fill, Font, Line, LineShape, Marker, Mode, Title,
 };
 use plotly::layout::{Axis, BarMode, Layout, Legend, TicksDirection};
-use plotly::{Bar, NamedColor, Plot, Rgb, Rgba, Scatter};
+use plotly::{Bar, color::{NamedColor, Rgb, Rgba}, Plot, Scatter};
 use rand_distr::{Distribution, Normal, Uniform};
 ```
 
@@ -28,7 +28,7 @@ fn adding_names_to_line_and_scatter_plot(show: bool) {
         .mode(Mode::LinesMarkers)
         .name("Scatter + Lines");
 
-    let layout = Layout::new().title(Title::new("Adding Names to Line and Scatter Plot"));
+    let layout = Layout::new().title(Title::with_text("Adding Names to Line and Scatter Plot"));
     let mut plot = Plot::new();
     plot.add_trace(trace1);
     plot.add_trace(trace2);
@@ -74,7 +74,7 @@ fn line_and_scatter_styling(show: bool) {
         .marker(Marker::new().color(Rgb::new(128, 0, 128)).size(12))
         .line(Line::new().color(Rgb::new(128, 0, 128)).width(1.0));
 
-    let layout = Layout::new().title(Title::new("Line and Scatter Styling"));
+    let layout = Layout::new().title(Title::with_text("Line and Scatter Styling"));
     let mut plot = Plot::new();
     plot.add_trace(trace1);
     plot.add_trace(trace2);
@@ -114,7 +114,7 @@ fn styling_line_plot(show: bool) {
         .line(Line::new().color(Rgb::new(55, 128, 191)).width(1.0));
 
     let layout = Layout::new()
-        .title(Title::new("Styling Line Plot"))
+        .title(Title::with_text("Styling Line Plot"))
         .width(500)
         .height(500);
     let mut plot = Plot::new();

docs/book/src/recipes/basic_charts/scatter_plots.md

@@ -8,7 +8,7 @@ use plotly::common::{
     ColorScale, ColorScalePalette, DashType, Fill, Font, Line, LineShape, Marker, Mode, Title,
 };
 use plotly::layout::{Axis, BarMode, Layout, Legend, TicksDirection};
-use plotly::{Bar, NamedColor, Plot, Rgb, Rgba, Scatter};
+use plotly::{Bar, color::{NamedColor, Rgb, Rgba}, Plot, Scatter};
 use rand_distr::{Distribution, Normal, Uniform};
 ```
 
@@ -156,9 +156,9 @@ fn data_labels_hover(show: bool) {
     plot.add_trace(trace2);
 
     let layout = Layout::new()
-        .title(Title::new("Data Labels Hover"))
-        .x_axis(Axis::new().title(Title::new("x")).range(vec![0.75, 5.25]))
-        .y_axis(Axis::new().title(Title::new("y")).range(vec![0., 8.]));
+        .title(Title::with_text("Data Labels Hover"))
+        .x_axis(Axis::new().title(Title::with_text("x")).range(vec![0.75, 5.25]))
+        .y_axis(Axis::new().title(Title::with_text("y")).range(vec![0., 8.]));
     plot.set_layout(layout);
     if show {
         plot.show();
@@ -201,7 +201,7 @@ fn data_labels_on_the_plot(show: bool) {
     plot.add_trace(trace2);
 
     let layout = Layout::new()
-        .title(Title::new("Data Labels on the Plot"))
+        .title(Title::with_text("Data Labels on the Plot"))
         .x_axis(Axis::new().range(vec![0.75, 5.25]))
         .y_axis(Axis::new().range(vec![0., 8.]));
     plot.set_layout(layout);
@@ -295,14 +295,14 @@ fn colored_and_styled_scatter_plot(show: bool) {
     .marker(Marker::new().color(Rgb::new(142, 124, 195)).size(12));
 
     let layout = Layout::new()
-        .title(Title::new("Quarter 1 Growth"))
+        .title(Title::with_text("Quarter 1 Growth"))
         .x_axis(
             Axis::new()
-                .title(Title::new("GDP per Capita"))
+                .title(Title::with_text("GDP per Capita"))
                 .show_grid(false)
                 .zero_line(false),
         )
-        .y_axis(Axis::new().title(Title::new("Percent")).show_line(false));
+        .y_axis(Axis::new().title(Title::with_text("Percent")).show_line(false));
     let mut plot = Plot::new();
     plot.add_trace(trace1);
     plot.add_trace(trace2);

docs/book/src/recipes/financial_charts/time_series_and_date_axes.md

@@ -27,7 +27,7 @@ fn time_series_plot_with_custom_date_range(show: bool) {
 
     let layout = Layout::new()
         .x_axis(Axis::new().range(vec!["2016-07-01", "2016-12-31"]))
-        .title(Title::new("Manually Set Date Range"));
+        .title(Title::with_text("Manually Set Date Range"));
     plot.set_layout(layout);
 
     if show {
@@ -68,7 +68,7 @@ fn time_series_with_range_slider(show: bool) {
 
     let layout = Layout::new()
         .x_axis(Axis::new().range_slider(RangeSlider::new().visible(true)))
-        .title(Title::new("Manually Set Date Range"));
+        .title(Title::with_text("Manually Set Date Range"));
     plot.set_layout(layout);
 
     if show {

docs/book/src/recipes/scientific_charts/contour_plots.md

@@ -72,7 +72,7 @@ fn colorscale_for_contour_plot(show: bool) {
     ];
     let trace = Contour::new_z(z).color_scale(ColorScale::Palette(ColorScalePalette::Jet));
 
-    let layout = Layout::new().title(Title::new("Colorscale for Contour Plot"));
+    let layout = Layout::new().title(Title::with_text("Colorscale for Contour Plot"));
     let mut plot = Plot::new();
     plot.set_layout(layout);
     plot.add_trace(trace);
@@ -115,7 +115,7 @@ fn customizing_size_and_range_of_a_contour_plots_contours(show: bool) {
         .auto_contour(false)
         .contours(Contours::new().start(0.0).end(8.0).size(2));
 
-    let layout = Layout::new().title(Title::new("Customizing Size and Range of Contours"));
+    let layout = Layout::new().title(Title::with_text("Customizing Size and Range of Contours"));
     let mut plot = Plot::new();
     plot.set_layout(layout);
     plot.add_trace(trace);
@@ -161,7 +161,7 @@ fn customizing_spacing_between_x_and_y_ticks(show: bool) {
         .dy(10.0)
         .y0(10.0);
 
-    let layout = Layout::new().title(Title::new("Customizing Size and Range of Contours"));
+    let layout = Layout::new().title(Title::with_text("Customizing Size and Range of Contours"));
     let mut plot = Plot::new();
     plot.set_layout(layout);
     plot.add_trace(trace);

docs/book/src/recipes/statistical_charts/box_plots.md

@@ -8,7 +8,7 @@ use plotly::box_plot::{BoxMean, BoxPoints};
 use plotly::common::{ErrorData, ErrorType, Line, Marker, Mode, Orientation, Title};
 use plotly::histogram::{Bins, Cumulative, HistFunc, HistNorm};
 use plotly::layout::{Axis, BarMode, BoxMode, Layout, Margin};
-use plotly::{Bar, BoxPlot, Histogram, NamedColor, Plot, Rgb, Rgba, Scatter};
+use plotly::{Bar, BoxPlot, Histogram, color::{NamedColor, Rgb, Rgba}, Scatter};
 use rand_distr::{Distribution, Normal, Uniform};
 
 ```
@@ -156,7 +156,7 @@ fn grouped_box_plot(show: bool) {
     let layout = Layout::new()
         .y_axis(
             Axis::new()
-                .title(Title::new("normalized moisture"))
+                .title(Title::with_text("normalized moisture"))
                 .zero_line(false),
         )
         .box_mode(BoxMode::Group);
@@ -222,7 +222,7 @@ fn box_plot_styling_outliers(show: bool) {
         .marker(Marker::new().color(Rgb::new(107, 174, 214)))
         .box_points(BoxPoints::Outliers);
 
-    let layout = Layout::new().title(Title::new("Box Plot Styling Outliers"));
+    let layout = Layout::new().title(Title::with_text("Box Plot Styling Outliers"));
 
     let mut plot = Plot::new();
     plot.set_layout(layout);
@@ -272,7 +272,7 @@ fn box_plot_styling_mean_and_standard_deviation(show: bool) {
         .name("Mean and Standard Deviation")
         .marker(Marker::new().color(Rgb::new(8, 81, 156)))
         .box_mean(BoxMean::StandardDeviation);
-    let layout = Layout::new().title(Title::new("Box Plot Styling Mean and Standard Deviation"));
+    let layout = Layout::new().title(Title::with_text("Box Plot Styling Mean and Standard Deviation"));
 
     let mut plot = Plot::new();
     plot.set_layout(layout);
@@ -341,10 +341,10 @@ fn grouped_horizontal_box_plot(show: bool) {
     plot.add_trace(trace3);
 
     let layout = Layout::new()
-        .title(Title::new("Grouped Horizontal Box Plot"))
+        .title(Title::with_text("Grouped Horizontal Box Plot"))
         .x_axis(
             Axis::new()
-                .title(Title::new("normalized moisture"))
+                .title(Title::with_text("normalized moisture"))
                 .zero_line(false),
         )
         .box_mode(BoxMode::Group);

docs/book/src/recipes/statistical_charts/error_bars.md

@@ -8,7 +8,7 @@ use plotly::box_plot::{BoxMean, BoxPoints};
 use plotly::common::{ErrorData, ErrorType, Line, Marker, Mode, Orientation, Title};
 use plotly::histogram::{Bins, Cumulative, HistFunc, HistNorm};
 use plotly::layout::{Axis, BarMode, BoxMode, Layout, Margin};
-use plotly::{Bar, BoxPlot, Histogram, NamedColor, Plot, Rgb, Rgba, Scatter};
+use plotly::{Bar, BoxPlot, Histogram, Plot, color::{NamedColor, Rgb, Rgba}, Scatter};
 use rand_distr::{Distribution, Normal, Uniform};
 
 ```

docs/book/src/recipes/statistical_charts/histograms.md

@@ -8,7 +8,7 @@ use plotly::box_plot::{BoxMean, BoxPoints};
 use plotly::common::{ErrorData, ErrorType, Line, Marker, Mode, Orientation, Title};
 use plotly::histogram::{Bins, Cumulative, HistFunc, HistNorm};
 use plotly::layout::{Axis, BarMode, BoxMode, Layout, Margin};
-use plotly::{Bar, BoxPlot, Histogram, NamedColor, Plot, Rgb, Rgba, Scatter};
+use plotly::{Bar, BoxPlot, Histogram, Plot, color::{NamedColor, Rgb, Rgba}, Scatter};
 use rand_distr::{Distribution, Normal, Uniform};
 
 ```
@@ -201,9 +201,9 @@ fn colored_and_styled_histograms(show: bool) {
         .auto_bin_x(false)
         .x_bins(Bins::new(-3.2, 4.0, 0.06));
     let layout = Layout::new()
-        .title(Title::new("Sampled Results"))
-        .x_axis(Axis::new().title(Title::new("Value")))
-        .y_axis(Axis::new().title(Title::new("Count")))
+        .title(Title::with_text("Sampled Results"))
+        .x_axis(Axis::new().title(Title::with_text("Value")))
+        .y_axis(Axis::new().title(Title::with_text("Count")))
         .bar_mode(BarMode::Overlay)
         .bar_gap(0.05)
         .bar_group_gap(0.2);