build mdbook as part of the PR CI

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

Author: andrei-ng

.github/workflows/ci.yml

@@ -123,3 +123,22 @@ jobs:
         with:
           targets: wasm32-unknown-unknown
       - run: cd ${{ github.workspace }}/examples/wasm-yew/${{ matrix.example }} && cargo build --target wasm32-unknown-unknown
+
+  build_book:
+    name: Build Book 
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - run: cargo install mdbook --no-default-features --features search --vers "^0.4" --locked --quiet
+      - name: Build examples to generate needed html files
+        run: |
+          cd ${{ github.workspace }}/examples/basic_charts && cargo run
+          cd ${{ github.workspace }}/examples/statistical_charts && cargo run
+          cd ${{ github.workspace }}/examples/scientific_charts && cargo run
+          cd ${{ github.workspace }}/examples/financial_charts && cargo run
+          cd ${{ github.workspace }}/examples/3d_charts && cargo run
+          cd ${{ github.workspace }}/examples/subplots && cargo run
+          cd ${{ github.workspace }}/examples/shapes && cargo run
+      - name: Build book 
+        run: mdbook build docs/book

examples/3d_charts/src/main.rs

@@ -262,7 +262,7 @@ fn colorscale_plot(show: bool, file_name: &str) {
 fn write_example_to_html(plot: &Plot, name: &str) -> String {
     std::fs::create_dir_all("./output").unwrap();
     // Write inline HTML
-    let html = plot.to_inline_html(Some(&name));
+    let html = plot.to_inline_html(Some(name));
     let path = format!("./output/inline_{}.html", name);
     std::fs::write(path, html).unwrap();
     // Write standalone HTML

examples/basic_charts/src/main.rs

@@ -961,7 +961,7 @@ fn grouped_donout_pie_charts(show: bool, file_name: &str) {
 fn write_example_to_html(plot: &Plot, name: &str) -> String {
     std::fs::create_dir_all("./output").unwrap();
     // Write inline HTML
-    let html = plot.to_inline_html(Some(&name));
+    let html = plot.to_inline_html(Some(name));
     let path = format!("./output/inline_{}.html", name);
     std::fs::write(path, html).unwrap();
     // Write standalone HTML

examples/custom_controls/src/main.rs

@@ -120,7 +120,7 @@ fn bar_chart_with_modifiable_bar_mode(show: bool, file_name: &str) {
 fn write_example_to_html(plot: &Plot, name: &str) -> String {
     std::fs::create_dir_all("./output").unwrap();
     // Write inline HTML
-    let html = plot.to_inline_html(Some(&name));
+    let html = plot.to_inline_html(Some(name));
     let path = format!("./output/inline_{}.html", name);
     std::fs::write(path, html).unwrap();
     // Write standalone HTML

examples/customization/src/main.rs

@@ -133,7 +133,7 @@ fn show_with_default_app(temp_path: &str) {
 fn write_example_to_html(plot: &Plot, name: &str) -> String {
     std::fs::create_dir_all("./output").unwrap();
     // Write inline HTML
-    let html = plot.to_inline_html(Some(&name));
+    let html = plot.to_inline_html(Some(name));
     let path = format!("./output/inline_{}.html", name);
     std::fs::write(path, html).unwrap();
     // Write standalone HTML

examples/financial_charts/src/main.rs

@@ -322,7 +322,7 @@ fn simple_ohlc_chart(show: bool, file_name: &str) {
 fn write_example_to_html(plot: &Plot, name: &str) -> String {
     std::fs::create_dir_all("./output").unwrap();
     // Write inline HTML
-    let html = plot.to_inline_html(Some(&name));
+    let html = plot.to_inline_html(Some(name));
     let path = format!("./output/inline_{}.html", name);
     std::fs::write(path, html).unwrap();
     // Write standalone HTML

examples/images/src/main.rs

@@ -105,7 +105,7 @@ fn trace_from_ndarray_rgba(show: bool, file_name: &str) {
 fn write_example_to_html(plot: &Plot, name: &str) -> String {
     std::fs::create_dir_all("./output").unwrap();
     // Write inline HTML
-    let html = plot.to_inline_html(Some(&name));
+    let html = plot.to_inline_html(Some(name));
     let path = format!("./output/inline_{}.html", name);
     std::fs::write(path, html).unwrap();
     // Write standalone HTML

examples/maps/src/main.rs

@@ -162,7 +162,7 @@ fn density_mapbox(show: bool, file_name: &str) {
 fn write_example_to_html(plot: &Plot, name: &str) -> String {
     std::fs::create_dir_all("./output").unwrap();
     // Write inline HTML
-    let html = plot.to_inline_html(Some(&name));
+    let html = plot.to_inline_html(Some(name));
     let path = format!("./output/inline_{}.html", name);
     std::fs::write(path, html).unwrap();
     // Write standalone HTML

examples/ndarray/src/main.rs

@@ -76,7 +76,7 @@ fn multiple_ndarray_traces_over_rows(show: bool, file_name: &str) {
 fn write_example_to_html(plot: &Plot, name: &str) -> String {
     std::fs::create_dir_all("./output").unwrap();
     // Write inline HTML
-    let html = plot.to_inline_html(Some(&name));
+    let html = plot.to_inline_html(Some(name));
     let path = format!("./output/inline_{}.html", name);
     std::fs::write(path, html).unwrap();
     // Write standalone HTML

examples/scientific_charts/src/main.rs

@@ -179,7 +179,7 @@ fn customized_heat_map(show: bool, file_name: &str) {
 fn write_example_to_html(plot: &Plot, name: &str) -> String {
     std::fs::create_dir_all("./output").unwrap();
     // Write inline HTML
-    let html = plot.to_inline_html(Some(&name));
+    let html = plot.to_inline_html(Some(name));
     let path = format!("./output/inline_{}.html", name);
     std::fs::write(path, html).unwrap();
     // Write standalone HTML