Updated structure and content

rapidsai · Jul 7, 2023 · 5f964c6 · 5f964c6
1 parent 6582e77
commit 5f964c6
Show file tree

Hide file tree

Showing 39 changed files with 117 additions and 119 deletions.
diff --git a/docs/source/dataframe.rst → docs/source/api_reference/dataframe.rst b/docs/source/dataframe.rst → docs/source/api_reference/dataframe.rst
@@ -1,6 +1,8 @@
 API Reference
 =============
 
+The two main components to cuxfilter are `DataFrame` for connecting the dashboard to a cuDF backed dataframe, and `Dashboard` for setting dashboard options. 
+
 .. currentmodule:: cuxfilter.dataframe
 
 DataFrame

diff --git a/docs/source/charts/charts.rst b/docs/source/charts/charts.rst
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -60,8 +60,13 @@
 html_logo = "_static/rapids_logo.png"
 html_static_path = ["_static"]
 
+# Removes sidebar
 htmlhelp_basename = "cuxfilterdoc"
 
+html_sidebars = {
+  "user_guide/index": []
+}
+
 html_theme_options = {
     "external_links": [],
     "icon_links": [],

diff --git a/docs/source/examples/temp.png b/docs/source/examples/temp.png
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,26 +1,18 @@
-Welcome to cuxfilter's documentation!
+Welcome to cuxfilter's documentation
 =====================================
 
-cuxfilter acts as a connector library, which provides the connections between different visualization libraries and a GPU dataframe without much hassle. This also allows the user to use charts from different libraries in a single dashboard, while also providing the interaction.
+cuxfilter enables GPU accelerated cross-filtering dashboards from notebooks, in just a few lines of Python code. Well integrated with the HoloViz ecosystem, it also incorporates other outstanding visualization libraries. RAPIDS cuxfilter is ideal for multi-chart exploratory data analysis and dashboard prototyping within the RAPIDS ecosystem. 
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
-
-   ./installation.rst
-   ./dataframe.rst
-   ./deployment.rst
-   ./10_minutes_to_cuxfilter.ipynb
-   ./Dask-cudf-support.rst
-   ./charts/charts.rst
-   ./layouts/Layouts.ipynb
-   ./themes/Themes.ipynb
-   ./examples/examples.rst
+   user_guide/index
+   api_reference/dataframe
+
 
 Indices and tables
 ==================
 
 * :ref:`genindex`
-* :ref:`modindex`
 * :ref:`search`
diff --git a/docs/source/layouts/untitled.txt b/docs/source/layouts/untitled.txt
diff --git a/docs/source/temp.png b/docs/source/temp.png
diff --git a/docs/source/10_minutes_to_cuxfilter.ipynb → .../user_guide/10_minutes_to_cuxfilter.ipynb b/docs/source/10_minutes_to_cuxfilter.ipynb → .../user_guide/10_minutes_to_cuxfilter.ipynb
diff --git a/docs/source/Dask-cudf-support.rst → docs/source/user_guide/Dask-cudf-support.rst b/docs/source/Dask-cudf-support.rst → docs/source/user_guide/Dask-cudf-support.rst
diff --git a/docs/source/charts/bokeh_charts.rst → ...source/user_guide/charts/bokeh_charts.rst b/docs/source/charts/bokeh_charts.rst → ...source/user_guide/charts/bokeh_charts.rst
diff --git a/docs/source/charts/custom_charts.rst → ...ource/user_guide/charts/custom_charts.rst b/docs/source/charts/custom_charts.rst → ...ource/user_guide/charts/custom_charts.rst
diff --git a/docs/source/charts/datashader_charts.rst → ...e/user_guide/charts/datashader_charts.rst b/docs/source/charts/datashader_charts.rst → ...e/user_guide/charts/datashader_charts.rst
diff --git a/docs/source/charts/deckgl_charts.rst → ...ource/user_guide/charts/deckgl_charts.rst b/docs/source/charts/deckgl_charts.rst → ...ource/user_guide/charts/deckgl_charts.rst
diff --git a/docs/source/user_guide/charts/index.rst b/docs/source/user_guide/charts/index.rst
@@ -0,0 +1,20 @@
+Charts
+======
+
+cuxfilter is able to use a wide range of chart types: 
+
+* Bokeh: line and bar
+* Datashader: high density line, stacked line, scatter, geospatial scatter, heatmap, and graph
+* DeckGL: webGL based geospatial 2D and 3D choropleth
+* Widgets: sliders, dropdowns, and cards
+* Custom: data table
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   bokeh_charts.rst
+   datashader_charts.rst
+   deckgl_charts.rst
+   widgets.rst
+   custom_charts.rst
diff --git a/docs/source/charts/test_geoJSON.geojson → ...ce/user_guide/charts/test_geoJSON.geojson b/docs/source/charts/test_geoJSON.geojson → ...ce/user_guide/charts/test_geoJSON.geojson
diff --git a/docs/source/charts/panel_widgets.rst → docs/source/user_guide/charts/widgets.rst b/docs/source/charts/panel_widgets.rst → docs/source/user_guide/charts/widgets.rst
@@ -1,4 +1,4 @@
-Panel Widgets
+Widgets
 =============
 
 .. currentmodule:: cuxfilter.charts

diff --git a/docs/source/deployment.rst → docs/source/user_guide/deployment.rst b/docs/source/deployment.rst → docs/source/user_guide/deployment.rst
diff --git a/docs/source/examples/Mortgage_example.ipynb → ...ser_guide/examples/Mortgage_example.ipynb b/docs/source/examples/Mortgage_example.ipynb → ...ser_guide/examples/Mortgage_example.ipynb
diff --git a/docs/source/examples/NYC_taxi_example.ipynb → ...ser_guide/examples/NYC_taxi_example.ipynb b/docs/source/examples/NYC_taxi_example.ipynb → ...ser_guide/examples/NYC_taxi_example.ipynb
diff --git a/...rce/examples/auto_accidents_example.ipynb → ...ide/examples/auto_accidents_example.ipynb b/...rce/examples/auto_accidents_example.ipynb → ...ide/examples/auto_accidents_example.ipynb
diff --git a/docs/source/examples/graphs.ipynb → docs/source/user_guide/examples/graphs.ipynb b/docs/source/examples/graphs.ipynb → docs/source/user_guide/examples/graphs.ipynb
diff --git a/docs/source/examples/examples.rst → docs/source/user_guide/examples/index.rst b/docs/source/examples/examples.rst → docs/source/user_guide/examples/index.rst
@@ -1,5 +1,5 @@
-Examples
-========
+Example Dashboards
+==================
 
 .. toctree::
    :maxdepth: 1

diff --git a/docs/source/user_guide/index.rst b/docs/source/user_guide/index.rst
@@ -0,0 +1,16 @@
+User Guide
+==========
+
+The user guide is intended as an overview of cuxfilter's capabilities as well as a showcase for examples. The best place to start is `10 Minutes to Cuxfilter`. For more advanced topics, see `Dask-cudf-support` for multi-GPU capabilities and `deployment` for exporting a dashboard for standalone usage outside of a notebook. 
+
+.. toctree::
+    :maxdepth: 2
+
+    installation
+    10_minutes_to_cuxfilter
+    charts/index
+    layouts/Layouts
+    themes/Themes
+    examples/index
+    Dask-cudf-support
+    deployment
diff --git a/docs/source/installation.rst → docs/source/user_guide/installation.rst b/docs/source/installation.rst → docs/source/user_guide/installation.rst
@@ -3,18 +3,18 @@ Installation
 
 Conda
 -----
-For the most customized way of installing RAPIDS and cuxfilter, visit the selector on the RAPIDS `Get Started Page <https://rapids.ai/start.html#rapids-release-selector>`_.
+For the most customized way of installing RAPIDS and cuxfilter, visit the selector on the RAPIDS `Install Page <https://docs.rapids.ai/install>`_.
 
 cuxfilter conda example installation:
 
 .. code-block:: bash
 
     conda install -c rapidsai -c conda-forge -c nvidia \
-        cuxfilter=23.02 python=3.10 cudatoolkit=11.8
+        cuxfilter=23.6 python=3.10 cudatoolkit=11.8
 
 Docker container
 ----------------
-For the most customized way of installing RAPIDS and cuxfilter, visit the selector on the RAPIDS `Get Started Page <https://rapids.ai/start.html#rapids-release-selector>`_.
+For the most customized way of installing RAPIDS and cuxfilter, visit the selector on the RAPIDS `Install Page <https://docs.rapids.ai/install>`_.
 
 cuxfilter docker example installation:
 
@@ -30,14 +30,14 @@ cuxfilter docker example installation:
 Build/Install from Source
 -------------------------
 
-See `build instructions <https://github.com/rapidsai/cuxfilter/blob/branch-23.02/CONTRIBUTING.md#setting-up-your-build-environment>`_.
+See `build instructions <https://github.com/rapidsai/cuxfilter/blob/main/CONTRIBUTING.md#setting-up-your-build-environment>` on our GitHub.
 
 
 
 Troubleshooting
 ---------------
 
-1. Install jupyterlab dependencies
+Install jupyterlab dependencies
 **********************************
 
 .. code-block:: bash
@@ -46,18 +46,8 @@ Troubleshooting
     jupyter labextension install @pyviz/jupyterlab_pyviz
     jupyter labextension install @bokeh/jupyter_bokeh
 
-2.running the server
-********************
-
-.. code-block:: bash
 
-    #enter ip address without http://
-    #current port is the port at which jupyterlab is running
-    d.app(notebook_url='ip.addr:current_port')
-    # OR for a separate web app
-    d.show(notebook_url='ip.addr:current_port')
-
-3. libxcomposite.so.1 not found error
+libxcomposite.so.1 not found error
 *************************************
 
 If using **await d.preview()** throws a **libxcomposite.so.1 not found error**, execute the following commands:
@@ -67,13 +57,14 @@ If using **await d.preview()** throws a **libxcomposite.so.1 not found error**,
     apt-get update
     apt-get install libxcomposite1 libxcursor1 libxdamage1 libxfixes3 libxi6 libxrandr2 libxtst6 libcups2 libxss1 libasound2 libpangocairo-1.0-0 libpango-1.0-0 libatk1.0-0 libgtk-3-0 libgdk-pixbuf2.0-0
 
+
 Download datasets
 -----------------
 
-1. Auto download datasets
+1. Automatically download datasets
 *************************
 
-The notebooks inside `python/notebooks` already have a check function which verifies whether the example dataset is downloaded, and downloads it if it's not.
+The notebooks inside `python/notebooks` already have a check function which verifies whether the example dataset is downloaded, and downloads if not present.
 
 2. Download manually
 ********************

diff --git a/docs/source/layouts/Layouts.ipynb → docs/source/user_guide/layouts/Layouts.ipynb b/docs/source/layouts/Layouts.ipynb → docs/source/user_guide/layouts/Layouts.ipynb
diff --git a/...outs/layout_thumbnails/double_feature.png → ...outs/layout_thumbnails/double_feature.png b/...outs/layout_thumbnails/double_feature.png → ...outs/layout_thumbnails/double_feature.png
diff --git a/...t_thumbnails/double_feature_quad_base.png → ...t_thumbnails/double_feature_quad_base.png b/...t_thumbnails/double_feature_quad_base.png → ...t_thumbnails/double_feature_quad_base.png
diff --git a/...ts/layout_thumbnails/feature_and_base.png → ...ts/layout_thumbnails/feature_and_base.png b/...ts/layout_thumbnails/feature_and_base.png → ...ts/layout_thumbnails/feature_and_base.png
diff --git a/...ut_thumbnails/feature_and_double_base.png → ...ut_thumbnails/feature_and_double_base.png b/...ut_thumbnails/feature_and_double_base.png → ...ut_thumbnails/feature_and_double_base.png
diff --git a/...yout_thumbnails/feature_and_five_edge.png → ...yout_thumbnails/feature_and_five_edge.png b/...yout_thumbnails/feature_and_five_edge.png → ...yout_thumbnails/feature_and_five_edge.png
diff --git a/...yout_thumbnails/feature_and_quad_base.png → ...yout_thumbnails/feature_and_quad_base.png b/...yout_thumbnails/feature_and_quad_base.png → ...yout_thumbnails/feature_and_quad_base.png
diff --git a/...ut_thumbnails/feature_and_triple_base.png → ...ut_thumbnails/feature_and_triple_base.png b/...ut_thumbnails/feature_and_triple_base.png → ...ut_thumbnails/feature_and_triple_base.png
diff --git a/..._thumbnails/left_feature_right_double.png → ..._thumbnails/left_feature_right_double.png b/..._thumbnails/left_feature_right_double.png → ..._thumbnails/left_feature_right_double.png
diff --git a/...outs/layout_thumbnails/single_feature.png → ...outs/layout_thumbnails/single_feature.png b/...outs/layout_thumbnails/single_feature.png → ...outs/layout_thumbnails/single_feature.png
diff --git a/...outs/layout_thumbnails/three_by_three.png → ...outs/layout_thumbnails/three_by_three.png b/...outs/layout_thumbnails/three_by_three.png → ...outs/layout_thumbnails/three_by_three.png
diff --git a/...outs/layout_thumbnails/triple_feature.png → ...outs/layout_thumbnails/triple_feature.png b/...outs/layout_thumbnails/triple_feature.png → ...outs/layout_thumbnails/triple_feature.png
diff --git a/...ayouts/layout_thumbnails/two_by_three.png → ...ayouts/layout_thumbnails/two_by_three.png b/...ayouts/layout_thumbnails/two_by_three.png → ...ayouts/layout_thumbnails/two_by_three.png
diff --git a/.../layouts/layout_thumbnails/two_by_two.png → .../layouts/layout_thumbnails/two_by_two.png b/.../layouts/layout_thumbnails/two_by_two.png → .../layouts/layout_thumbnails/two_by_two.png
diff --git a/docs/source/themes/Themes.ipynb → docs/source/user_guide/themes/Themes.ipynb b/docs/source/themes/Themes.ipynb → docs/source/user_guide/themes/Themes.ipynb