Update docs

vizzuhq · Dec 13, 2023 · 425bd2f · 425bd2f
1 parent 1dfd854
commit 425bd2f
Show file tree

Hide file tree

Showing 60 changed files with 410 additions and 554 deletions.
diff --git a/.gitignore b/.gitignore
@@ -9,11 +9,12 @@ dist
 
 vizzu-lib
 
-.venv
+.venv*
 .pdm-python
 .tox
 .coverage
 
+placeholder-plugin.yaml
 site
 .chromium
 node_modules
diff --git a/docs/environments/bi/mode.md b/docs/environments/bi/mode.md
@@ -60,7 +60,7 @@ chart = Chart(
 
 data = Data()
 df = pd.read_csv(
-    "https://ipyvizzu.vizzuhq.com/latest/showcases/titanic/titanic.csv"
+    "https://xIPYVIZZU_MINOR_VERSIONx/showcases/titanic/titanic.csv"
 )
 data.add_df(df)
 

diff --git a/docs/environments/ide/pycharm.md b/docs/environments/ide/pycharm.md
@@ -66,7 +66,7 @@ chart = Chart(
 
 data = Data()
 df = pd.read_csv(
-    "https://ipyvizzu.vizzuhq.com/latest/showcases/titanic/titanic.csv"
+    "https://xIPYVIZZU_MINOR_VERSIONx/showcases/titanic/titanic.csv"
 )
 data.add_df(df)
 

diff --git a/docs/environments/ide/vscode.md b/docs/environments/ide/vscode.md
@@ -66,7 +66,7 @@ chart = Chart(
 
 data = Data()
 df = pd.read_csv(
-    "https://ipyvizzu.vizzuhq.com/latest/showcases/titanic/titanic.csv"
+    "https://xIPYVIZZU_MINOR_VERSIONx/showcases/titanic/titanic.csv"
 )
 data.add_df(df)
 

diff --git a/docs/environments/notebook/colab.md b/docs/environments/notebook/colab.md
@@ -64,7 +64,7 @@ chart = Chart(
 
 data = Data()
 df = pd.read_csv(
-    "https://ipyvizzu.vizzuhq.com/latest/showcases/titanic/titanic.csv"
+    "https://xIPYVIZZU_MINOR_VERSIONx/showcases/titanic/titanic.csv"
 )
 data.add_df(df)
 

diff --git a/docs/environments/notebook/databricks.md b/docs/environments/notebook/databricks.md
@@ -64,7 +64,7 @@ chart = Chart(
 
 data = Data()
 df = pd.read_csv(
-    "https://ipyvizzu.vizzuhq.com/latest/showcases/titanic/titanic.csv"
+    "https://xIPYVIZZU_MINOR_VERSIONx/showcases/titanic/titanic.csv"
 )
 data.add_df(df)
 

diff --git a/docs/environments/notebook/datacamp.md b/docs/environments/notebook/datacamp.md
@@ -65,7 +65,7 @@ chart = Chart(
 
 data = Data()
 df = pd.read_csv(
-    "https://ipyvizzu.vizzuhq.com/latest/showcases/titanic/titanic.csv"
+    "https://xIPYVIZZU_MINOR_VERSIONx/showcases/titanic/titanic.csv"
 )
 data.add_df(df)
 chart.animate(data)

diff --git a/docs/environments/notebook/deepnote.md b/docs/environments/notebook/deepnote.md
@@ -64,7 +64,7 @@ chart = Chart(
 
 data = Data()
 df = pd.read_csv(
-    "https://ipyvizzu.vizzuhq.com/latest/showcases/titanic/titanic.csv"
+    "https://xIPYVIZZU_MINOR_VERSIONx/showcases/titanic/titanic.csv"
 )
 data.add_df(df)
 

diff --git a/docs/environments/notebook/jupyterlab.md b/docs/environments/notebook/jupyterlab.md
@@ -69,7 +69,7 @@ chart = Chart(
 
 data = Data()
 df = pd.read_csv(
-    "https://ipyvizzu.vizzuhq.com/latest/showcases/titanic/titanic.csv"
+    "https://xIPYVIZZU_MINOR_VERSIONx/showcases/titanic/titanic.csv"
 )
 data.add_df(df)
 

diff --git a/docs/environments/notebook/jupyterlite.md b/docs/environments/notebook/jupyterlite.md
@@ -65,7 +65,7 @@ chart = Chart(
 
 # add data to Chart
 # download data from
-# "https://ipyvizzu.vizzuhq.com/latest/showcases/titanic/titanic.csv"
+# "https://xIPYVIZZU_MINOR_VERSIONx/showcases/titanic/titanic.csv"
 # and place it in your JupyterLite workspace
 
 DB_NAME = "JupyterLite Storage"

diff --git a/docs/environments/notebook/jupyternotebook.md b/docs/environments/notebook/jupyternotebook.md
@@ -69,7 +69,7 @@ chart = Chart(
 
 data = Data()
 df = pd.read_csv(
-    "https://ipyvizzu.vizzuhq.com/latest/showcases/titanic/titanic.csv"
+    "https://xIPYVIZZU_MINOR_VERSIONx/showcases/titanic/titanic.csv"
 )
 data.add_df(df)
 

diff --git a/docs/environments/notebook/kaggle.md b/docs/environments/notebook/kaggle.md
@@ -67,7 +67,7 @@ chart = Chart(
 
 data = Data()
 df = pd.read_csv(
-    "https://ipyvizzu.vizzuhq.com/latest/showcases/titanic/titanic.csv"
+    "https://xIPYVIZZU_MINOR_VERSIONx/showcases/titanic/titanic.csv"
 )
 data.add_df(df)
 

diff --git a/docs/environments/notebook/noteable.md b/docs/environments/notebook/noteable.md
@@ -63,7 +63,7 @@ chart = Chart(
 
 data = Data()
 df = pd.read_csv(
-    "https://ipyvizzu.vizzuhq.com/latest/showcases/titanic/titanic.csv"
+    "https://xIPYVIZZU_MINOR_VERSIONx/showcases/titanic/titanic.csv"
 )
 data.add_df(df)
 

diff --git a/docs/environments/platform/flask.md b/docs/environments/platform/flask.md
@@ -64,7 +64,7 @@ chart = Chart(
 
 data = Data()
 df = pd.read_csv(
-    "https://ipyvizzu.vizzuhq.com/latest/showcases/titanic/titanic.csv"
+    "https://xIPYVIZZU_MINOR_VERSIONx/showcases/titanic/titanic.csv"
 )
 data.add_df(df)
 

diff --git a/docs/environments/platform/mercury.md b/docs/environments/platform/mercury.md
@@ -84,7 +84,7 @@ chart = Chart(
 
 data = Data()
 df = pd.read_csv(
-    "https://ipyvizzu.vizzuhq.com/latest/showcases/titanic/titanic.csv"
+    "https://xIPYVIZZU_MINOR_VERSIONx/showcases/titanic/titanic.csv"
 )
 data.add_df(df)
 

diff --git a/docs/environments/platform/panel.md b/docs/environments/platform/panel.md
@@ -61,7 +61,7 @@ def create_chart():
 
     data = Data()
     df = pd.read_csv(
-        "https://ipyvizzu.vizzuhq.com/latest/showcases/titanic/titanic.csv"
+        "https://xIPYVIZZU_MINOR_VERSIONx/showcases/titanic/titanic.csv"
     )
     data.add_df(df)
 

diff --git a/docs/environments/platform/streamlit.md b/docs/environments/platform/streamlit.md
@@ -66,7 +66,7 @@ def create_chart():
 
     data = Data()
     df = pd.read_csv(
-        "https://ipyvizzu.vizzuhq.com/latest/showcases/titanic/titanic.csv"
+        "https://xIPYVIZZU_MINOR_VERSIONx/showcases/titanic/titanic.csv"
     )
     data.add_df(df)
 

diff --git a/docs/environments/platform/voila.md b/docs/environments/platform/voila.md
@@ -69,7 +69,7 @@ chart = Chart(
 
 data = Data()
 df = pd.read_csv(
-    "https://ipyvizzu.vizzuhq.com/latest/showcases/titanic/titanic.csv"
+    "https://xIPYVIZZU_MINOR_VERSIONx/showcases/titanic/titanic.csv"
 )
 data.add_df(df)
 

diff --git a/docs/showcases/music.md b/docs/showcases/music.md
@@ -15,7 +15,7 @@ import pandas as pd
 from ipyvizzu import Chart, Data, Config, Style
 
 df = pd.read_csv(
-    "https://ipyvizzu.vizzuhq.com/latest/showcases/music/music.csv",
+    "https://xIPYVIZZU_MINOR_VERSIONx/showcases/music/music.csv",
     dtype={"Year": str},
 )
 data = Data()

diff --git a/docs/showcases/musicformats.md b/docs/showcases/musicformats.md
@@ -15,7 +15,7 @@ import pandas as pd
 from ipyvizzu import Chart, Data, Config, Style, DisplayTarget
 
 df = pd.read_csv(
-    "https://ipyvizzu.vizzuhq.com/latest/showcases/musicformats/musicformats.csv",
+    "https://xIPYVIZZU_MINOR_VERSIONx/showcases/musicformats/musicformats.csv",
     dtype={"Year": str},
 )
 data = Data()

diff --git a/docs/showcases/nadal.md b/docs/showcases/nadal.md
@@ -15,7 +15,7 @@ import pandas as pd
 from ipyvizzu import Chart, Data, Config, Style, DisplayTarget
 
 df = pd.read_csv(
-    "https://ipyvizzu.vizzuhq.com/latest/showcases/nadal/nadal.csv",
+    "https://xIPYVIZZU_MINOR_VERSIONx/showcases/nadal/nadal.csv",
     dtype={
         "Year": str,
         "Round": str,

diff --git a/docs/showcases/sales.md b/docs/showcases/sales.md
@@ -15,7 +15,7 @@ import pandas as pd
 from ipyvizzu import Chart, Data, Config, Style
 
 df = pd.read_csv(
-    "https://ipyvizzu.vizzuhq.com/latest/showcases/sales/sales.csv"
+    "https://xIPYVIZZU_MINOR_VERSIONx/showcases/sales/sales.csv"
 )
 data = Data()
 data.add_df(df)

diff --git a/docs/showcases/titanic.md b/docs/showcases/titanic.md
@@ -15,7 +15,7 @@ import pandas as pd
 from ipyvizzu import Chart, Data, Config
 
 df = pd.read_csv(
-    "https://ipyvizzu.vizzuhq.com/latest/showcases/titanic/titanic.csv"
+    "https://xIPYVIZZU_MINOR_VERSIONx/showcases/titanic/titanic.csv"
 )
 data = Data()
 data.add_df(df)

diff --git a/docs/tutorial/aggregating_data.md b/docs/tutorial/aggregating_data.md
@@ -13,21 +13,7 @@ within `Genres`.
 
 <div id="tutorial_01"></div>
 
-??? info "Info - How to setup Chart"
-    ```python
-    import pandas as pd
-    from ipyvizzu import Chart, Data, Config
-
-    df = pd.read_csv(
-        "https://ipyvizzu.vizzuhq.com/latest/assets/data/music_data.csv"
-    )
-    data = Data()
-    data.add_df(df)
-
-    chart = Chart()
-
-    chart.animate(data)
-    ```
+{% include-markdown "tutorial/assets/setup/setup_a.md" %}
 
 ```python
 chart.animate(Config({"channels": {"y": {"set": ["Popularity"]}}}))

diff --git a/docs/tutorial/align_range.md b/docs/tutorial/align_range.md
@@ -21,34 +21,7 @@ whereas on a bar chart, horizontally.
 
 <div id="tutorial_01"></div>
 
-??? info "Info - How to setup Chart"
-    ```python
-    import pandas as pd
-    from ipyvizzu import Chart, Data, Config
-
-    df = pd.read_csv(
-        "https://ipyvizzu.vizzuhq.com/latest/assets/data/music_data.csv"
-    )
-    data = Data()
-    data.add_df(df)
-
-    chart = Chart()
-
-    chart.animate(data)
-
-    chart.animate(
-        Config(
-            {
-                "channels": {
-                    "y": {"set": ["Popularity", "Kinds"]},
-                    "x": {"set": ["Genres"]},
-                    "color": {"set": ["Kinds"]},
-                    "label": {"set": ["Popularity"]},
-                },
-            }
-        )
-    )
-    ```
+{% include-markdown "tutorial/assets/setup/setup_c.md" %}
 
 Change align and configures the y axis labels to disappear during the animation.
 

diff --git a/docs/tutorial/animation_control_keyframes.md b/docs/tutorial/animation_control_keyframes.md
@@ -5,40 +5,13 @@ csv_url: ../../assets/data/music_data.csv
 # Animation control & keyframes
 
 Using the `control` property provided by the chart you can play, pause, stop,
-seek or reverse the animations.
+seek, speed up or reverse the animations.
 
 In this step, we seek forward to `50%` of progress after the animation starts.
 
 <div id="tutorial_01"></div>
 
-??? info "Info - How to setup Chart"
-    ```python
-    import pandas as pd
-    from ipyvizzu import Chart, Data, Config, Keyframe
-
-    df = pd.read_csv(
-        "https://ipyvizzu.vizzuhq.com/latest/assets/data/music_data.csv"
-    )
-    data = Data()
-    data.add_df(df)
-
-    chart = Chart()
-
-    chart.animate(data)
-
-    chart.animate(
-        Config(
-            {
-                "channels": {
-                    "y": {"set": ["Popularity", "Kinds"]},
-                    "x": {"set": ["Genres"]},
-                    "color": {"set": ["Kinds"]},
-                    "label": {"set": ["Popularity"]},
-                },
-            }
-        )
-    )
-    ```
+{% include-markdown "tutorial/assets/setup/setup_c.md" %}
 
 ```python
 chart.animate(

diff --git a/docs/tutorial/animation_options.md b/docs/tutorial/animation_options.md
@@ -14,34 +14,7 @@ the default animation options.
 
 <div id="tutorial_01"></div>
 
-??? info "Info - How to setup Chart"
-    ```python
-    import pandas as pd
-    from ipyvizzu import Chart, Data, Config
-
-    df = pd.read_csv(
-        "https://ipyvizzu.vizzuhq.com/latest/assets/data/music_data.csv"
-    )
-    data = Data()
-    data.add_df(df)
-
-    chart = Chart()
-
-    chart.animate(data)
-
-    chart.animate(
-        Config(
-            {
-                "channels": {
-                    "y": {"set": ["Popularity", "Kinds"]},
-                    "x": {"set": ["Genres"]},
-                    "color": {"set": ["Kinds"]},
-                    "label": {"set": ["Popularity"]},
-                },
-            }
-        )
-    )
-    ```
+{% include-markdown "tutorial/assets/setup/setup_c.md" %}
 
 ```python
 chart.animate(

diff --git a/docs/tutorial/assets/setup/config_a.md b/docs/tutorial/assets/setup/config_a.md
@@ -0,0 +1,3 @@
+```python
+chart.animate(data)
+```
diff --git a/docs/tutorial/assets/setup/config_b.md b/docs/tutorial/assets/setup/config_b.md
@@ -0,0 +1,12 @@
+```python
+chart.animate(
+    Config(
+        {
+            "channels": {
+                "y": {"set": ["Popularity"]},
+                "x": {"set": ["Genres"]},
+            },
+        }
+    )
+)
+```
diff --git a/docs/tutorial/assets/setup/config_c.md b/docs/tutorial/assets/setup/config_c.md
@@ -0,0 +1,15 @@
+```python
+chart.animate(
+    data,
+    Config(
+        {
+            "channels": {
+                "y": {"set": ["Popularity", "Kinds"]},
+                "x": {"set": ["Genres"]},
+                "color": {"set": ["Kinds"]},
+                "label": {"set": ["Popularity"]},
+            },
+        }
+    ),
+)
+```
diff --git a/docs/tutorial/assets/setup/init.md b/docs/tutorial/assets/setup/init.md
@@ -0,0 +1,12 @@
+```python
+import pandas as pd
+from ipyvizzu import Chart, Data, Config
+
+df = pd.read_csv(
+    "https://xIPYVIZZU_MINOR_VERSIONx/assets/data/music_data.csv"
+)
+data = Data()
+data.add_df(df)
+
+chart = Chart()
+```