docs: overhaul (#105)

An overhaul of the documentation -- almost a complete re-write. Main differences: * Added quick-start examples and other examples * Added many internal and external links * Changed structure (notably *getting started* and *advanced usage* sections transformed into *usage*)
datamole-ai · Sep 6, 2023 · 00da056 · 00da056
1 parent fff0fd1
commit 00da056
Show file tree

Hide file tree

Showing 7 changed files with 367 additions and 274 deletions.
diff --git a/docs/advanced.rst b/docs/advanced.rst
diff --git a/docs/api_reference.rst b/docs/api_reference.rst
@@ -1,4 +1,4 @@
-API reference
+API Reference
 =============
 
 .. toctree::

diff --git a/docs/getting_started.rst b/docs/getting_started.rst
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,15 +1,27 @@
 EDVART
 ================================
 
-Exploratory Data Analysis (EDA) is a very initial task a data scientist
-or data analyst does when he reaches new data.
-EDA refers to the critical process of performing
-initial investigations on data to discover patterns, to spot
-anomalies, to test hypothesis and to check assumptions with the help
-of summary statistics and graphical representations.
+Edvart is an open-source Python library designed to simplify and streamline
+your exploratory data analysis (EDA) process.
+Edvart supports different levels of customization:
+from a default report generated in one line of code to a fully-customized
+report down to the level of code generating the visualizations.
+
+Key Features
+------------
+* **One-line Reports**: Generate a comprehensive set of pandas DataFrame visualizations using a single Python statement.
+  Edvart supports:
+    * Data overview,
+    * Univariate analysis,
+    * Bivariate analysis,
+    * Multivariate analysis,
+    * Grouped analysis,
+    * Time series analysis.
+
+* **Customizable Reports**: Produce, iterate, and style detailed reports in Jupyter notebooks and HTML formats.
+* **Flexible API**: From high-level simplicity in a single line of code to detailed control, choose the API level that fits your needs.
+* **Interactive Visualizations**: Many of the visualizations are interactive and can be used to explore the data in detail.
 
-EDVART serves for speeding up EDA and for
-creating Data analysis reports.
 
 Table of Contents
 -----------------
@@ -18,15 +30,16 @@ Table of Contents
   :maxdepth: 2
 
   installation.rst
-  getting_started.rst
-  advanced.rst
+  usage.rst
+  sections.rst
   api_reference.rst
 
 .. include:: installation.rst
-.. include:: getting_started.rst
+.. include:: usage.rst
+.. include:: sections.rst
 
 Links
------------
+-----
 * `GitHub repository <https://github.com/datamole-ai/edvart>`_
 
 * :ref:`modindex`