update

Author: sylvaincom

doc/getting_started.rst

@@ -35,5 +35,7 @@ This will automatically open a browser at the UI's location:
 #. On the top left, create a new ``View``.
 #. From the ``Elements`` section on the bottom left, you can add stored items to this view, either by double-cliking on them or by doing drag-and-drop.
 
+For more features, please look into :ref:`auto_examples`.
+
 .. image:: https://raw.githubusercontent.com/sylvaincom/sylvaincom.github.io/master/files/probabl/skore/2024_10_14_skore_demo.gif
    :alt: Getting started with ``skore`` demo

doc/index.rst

@@ -10,9 +10,6 @@ Welcome to ``skore``
 
    * ``skore`` machine learning programming assistant: enhancing ``scikit-learn`` classes and functions
 
-#OwnYourDataScience
--------------------
-
 With the ``skore`` UI, data scientists can:
 
 #. Store objects of different types from their Python code: python lists, ``scikit-learn`` fitted pipelines, ``plotly`` figures, and more.
@@ -21,11 +18,12 @@ With the ``skore`` UI, data scientists can:
 
 With the ``skore`` machine learning programming assistant, data scientists can:
 
-* Use an enhanced version of ``sklearn.model_selection.cross_validate`` with ``skore.cross_validate``.
+* Use an enhanced version of ``sklearn.model_selection.cross_validate`` with ``skore``'s :func:`~skore.cross_validate`.
 
 These are only the first features: skore is a work in progress and aims to be
 an end-to-end library for data scientists.
 Stay tuned!
+We are a product team working at `Probabl <https://probabl.ai>`_ and our motto is #OwnYourDataScience.
 
 - License: BSD
 - GitHub repository: https://github.com/probabl-ai/skore

doc/sg_execution_times.rst

@@ -6,7 +6,7 @@
 
 Computation times
 =================
-**00:02.306** total execution time for 2 files **from all galleries**:
+**00:03.753** total execution time for 3 files **from all galleries**:
 
 .. container::
 
@@ -33,8 +33,11 @@ Computation times
      - Time
      - Mem (MB)
    * - :ref:`sphx_glr_auto_examples_plot_01_getting_started.py` (``../examples/plot_01_getting_started.py``)
-     - 00:02.306
+     - 00:01.402
+     - 0.0
+   * - :ref:`sphx_glr_auto_examples_plot_03_cross_validate.py` (``../examples/plot_03_cross_validate.py``)
+     - 00:01.324
      - 0.0
    * - :ref:`sphx_glr_auto_examples_plot_02_basic_usage.py` (``../examples/plot_02_basic_usage.py``)
-     - 00:00.000
+     - 00:01.027
      - 0.0

doc/user_guide.rst

@@ -8,4 +8,13 @@ User guide
 *The User Guide is currently work in progress and will be released soon, thank
 you for your patience!*
 
-For now, please look into the ``Getting Started`` and ``Examples`` tab.
+For now, please look into:
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   install
+   getting_started
+   auto_examples/index
+   api

examples/README.rst

@@ -1,3 +1,5 @@
+.. _auto_examples:
+
 Examples
 ========
 

examples/plot_01_getting_started.py

@@ -1,9 +1,9 @@
 """
-==============================
-Getting started with ``skore``
-==============================
+=================================
+1) Getting started with ``skore``
+=================================
 
-This example runs the `Getting started` guide.
+This example runs the :ref:`getting_started` guide.
 
 ``skore`` UI
 ------------