[ci skip] DOC improve landing page 2033243

scikit-learn-contrib · May 1, 2024 · cf8049f · cf8049f
1 parent a85d658
commit cf8049f
Show file tree

Hide file tree

Showing 31 changed files with 443 additions and 304 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 1d52ae40397019b4a3a804c0469850da
+config: c918da1e783294cecb26bd602d00f923
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip b/_downloads/07fcc19ba03226cd3d83d4e40ec44385/auto_examples_python.zip
diff --git a/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip b/_downloads/6f1e7a639e0699d6164445b55e6c116d/auto_examples_jupyter.zip
diff --git a/_sources/api.rst.txt b/_sources/api.rst.txt
@@ -1,6 +1,6 @@
-####################
-project-template API
-####################
+#############
+API Reference
+#############
 
 This is an example on how to document the API of your own project.
 

diff --git a/_sources/auto_examples/index.rst.txt b/_sources/auto_examples/index.rst.txt
@@ -2,8 +2,8 @@
 
 .. _general_examples:
 
-General examples
-================
+Example Gallery
+===============
 
 Introductory examples.
 

diff --git a/_sources/auto_examples/plot_template.rst.txt b/_sources/auto_examples/plot_template.rst.txt
@@ -53,7 +53,7 @@ An example plot of :class:`skltemplate.template.TemplateEstimator`
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 0.072 seconds)
+   **Total running time of the script:** (0 minutes 0.073 seconds)
 
 
 .. _sphx_glr_download_auto_examples_plot_template.py:

diff --git a/_sources/auto_examples/plot_transformer.rst.txt b/_sources/auto_examples/plot_transformer.rst.txt
@@ -62,7 +62,7 @@ An example plot of :class:`skltemplate.template.TemplateTransformer`
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 0.060 seconds)
+   **Total running time of the script:** (0 minutes 0.061 seconds)
 
 
 .. _sphx_glr_download_auto_examples_plot_transformer.py:

diff --git a/_sources/auto_examples/sg_execution_times.rst.txt b/_sources/auto_examples/sg_execution_times.rst.txt
@@ -36,8 +36,8 @@ Computation times
      - 00:00.080
      - 0.0
    * - :ref:`sphx_glr_auto_examples_plot_template.py` (``plot_template.py``)
-     - 00:00.072
+     - 00:00.073
      - 0.0
    * - :ref:`sphx_glr_auto_examples_plot_transformer.py` (``plot_transformer.py``)
-     - 00:00.060
+     - 00:00.061
      - 0.0
diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -3,50 +3,107 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to sklearn-template's documentation!
-============================================
+:notoc:
 
-This project is a reference implementation to anyone who wishes to develop
-scikit-learn compatible classes.
+#############################################
+Project template for `scikit-learn` extension
+#############################################
 
-.. toctree::
-   :maxdepth: 2
-   :hidden:
-   :caption: Getting Started
+**Date**: |today| **Version**: |version|
 
-   quick_start
+**Useful links**:
+`Source Repository <https://github.com/scikit-learn-contrib/project-template>`__ |
+`Issues & Ideas <https://github.com/scikit-learn-contrib/project-templatek/issues>`__ |
 
-.. toctree::
-   :maxdepth: 2
-   :hidden:
-   :caption: Documentation
+This is the documentation for the `project-template` to help at extending
+`scikit-learn`. It provides some information on how to build your own custom
+`scikit-learn` compatible estimators as well as a template to package them.
 
-   user_guide
-   api
+.. raw:: html
 
-.. toctree::
-   :maxdepth: 2
-   :hidden:
-   :caption: Tutorial - Examples
+    <div class="container">
+        <div class="row">
+            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
+                <div class="intro-card text-center sd-intro-card shadow">
+                <div class="sd-card-body flex-fill">
+                    <i class="fas fa-download fa-7x"></i>
+                    <h5 class="sd-card-title">Getting started</h5>
+                    <p class="sd-card-text">Information regarding this template and how
+                    to modify it for your own project.</p>
+
+.. container:: custom-button
+
+    :ref:`To the getting started guideline<quick_start>`
+
+.. raw:: html
+
+                </div>
+                </div>
+            </div>
+            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
+                <div class="intro-card text-center sd-intro-card shadow">
+                <div class="sd-card-body flex-fill">
+                    <i class="fas fa-book fa-7x"></i>
+                    <h5 class="sd-card-title">User guide</h5>
+                    <p class="sd-card-text">An example of narrative documentation.
+                    Here, we will explain how to create your own <em>scikit-learn</em>
+                    estimator.</p>
 
-   auto_examples/index
+.. container:: custom-button
 
-`Getting started <quick_start.html>`_
--------------------------------------
+    :ref:`To the user guide<user_guide>`
 
-Information regarding this template and how to modify it for your own project.
+.. raw:: html
 
-`User Guide <user_guide.html>`_
--------------------------------
+                </div>
+                </div>
+            </div>
+            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
+                <div class="intro-card text-center sd-intro-card shadow">
+                <div class="sd-card-body flex-fill">
+                    <i class="fas fa-code fa-7x"></i>
+                    <h5 class="sd-card-title">API reference</h5>
+                    <p class="sd-card-text">An example of API documentation. This
+                    is an example how to use <em>sphinx</em> to automatically generate
+                    reference API page.</p>
 
-An example of narrative documentation.
+.. container:: custom-button
 
-`API Documentation <api.html>`_
--------------------------------
+    :ref:`To the reference guide<api>`
 
-An example of API documentation.
+.. raw:: html
 
-`Examples <auto_examples/index.html>`_
---------------------------------------
+                </div>
+                </div>
+            </div>
+            <div class="col-lg-6 col-md-6 col-sm-6 col-xs-12 d-flex">
+                <div class="intro-card text-center sd-intro-card shadow">
+                <div class="sd-card-body flex-fill">
+                    <i class="fas fa-chart-bar fa-7x"></i>
+                    <h5 class="sd-card-title">Examples</h5>
+                    <p class="sd-card-text">A set of examples. It complements the User
+                    Guide and it is the right place to show how to use your compatible
+                    estimator.</p>
 
-A set of examples. It complements the `User Guide <user_guide.html>`_.
+.. container:: custom-button
+
+    :ref:`To the gallery of examples<general_examples>`
+
+.. raw:: html
+
+                </div>
+                </div>
+            </div>
+        </div>
+    </div>
+
+
+.. toctree::
+    :maxdepth: 3
+    :hidden:
+    :titlesonly:
+
+    quick_start
+    user_guide
+    api
+    auto_examples/index
diff --git a/_sources/quick_start.rst.txt b/_sources/quick_start.rst.txt
@@ -1,6 +1,6 @@
-#####################################
-Quick Start with the project-template
-#####################################
+###############
+Getting started
+###############
 
 This package serves as a skeleton package aiding at developing compatible
 scikit-learn contribution.

diff --git a/_sources/sg_execution_times.rst.txt b/_sources/sg_execution_times.rst.txt
@@ -36,8 +36,8 @@ Computation times
      - 00:00.080
      - 0.0
    * - :ref:`sphx_glr_auto_examples_plot_template.py` (``../examples/plot_template.py``)
-     - 00:00.072
+     - 00:00.073
      - 0.0
    * - :ref:`sphx_glr_auto_examples_plot_transformer.py` (``../examples/plot_transformer.py``)
-     - 00:00.060
+     - 00:00.061
      - 0.0
diff --git a/_sources/user_guide.rst.txt b/_sources/user_guide.rst.txt
@@ -2,9 +2,9 @@
 
 .. _user_guide:
 
-==================================================
-User guide: create your own scikit-learn estimator
-==================================================
+==========
+User Guide
+==========
 
 Estimator
 ---------

diff --git a/_static/img/logo.png b/_static/img/logo.png
diff --git a/_static/logo.png b/_static/logo.png
diff --git a/api.html b/api.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>project-template API &#8212; Scikit-learn Project Template 0.0.4.dev0 documentation</title>
+    <title>API Reference &#8212; Scikit-learn Project Template 0.0.4.dev0 documentation</title>
 
 
 
@@ -48,7 +48,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="TemplateEstimator" href="generated/skltemplate.TemplateEstimator.html" />
-    <link rel="prev" title="User guide: create your own scikit-learn estimator" href="user_guide.html" />
+    <link rel="prev" title="User Guide" href="user_guide.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
   </head>
@@ -120,8 +120,14 @@
 
 
 
+
+
+
+
+
+    <img src="_static/logo.png" class="logo__image only-light" alt="Scikit-learn Project Template 0.0.4.dev0 documentation - Home"/>
+    <script>document.write(`<img src="_static/logo.png" class="logo__image only-dark" alt="Scikit-learn Project Template 0.0.4.dev0 documentation - Home"/>`);</script>
 
-    <p class="title logo__title">Scikit-learn Project Template 0.0.4.dev0 documentation</p>
 
 </a></div>
 
@@ -137,28 +143,28 @@
 
                     <li class="nav-item">
                       <a class="nav-link nav-internal" href="quick_start.html">
-                        Quick Start with the project-template
+                        Getting started
                       </a>
                     </li>
 
 
                     <li class="nav-item">
                       <a class="nav-link nav-internal" href="user_guide.html">
-                        User guide: create your own scikit-learn estimator
+                        User Guide
                       </a>
                     </li>
 
 
                     <li class="nav-item current active">
                       <a class="nav-link nav-internal" href="#">
-                        project-template API
+                        API Reference
                       </a>
                     </li>
 
 
                     <li class="nav-item">
                       <a class="nav-link nav-internal" href="auto_examples/index.html">
-                        General examples
+                        Example Gallery
                       </a>
                     </li>
 
@@ -262,28 +268,28 @@
 
                     <li class="nav-item">
                       <a class="nav-link nav-internal" href="quick_start.html">
-                        Quick Start with the project-template
+                        Getting started
                       </a>
                     </li>
 
 
                     <li class="nav-item">
                       <a class="nav-link nav-internal" href="user_guide.html">
-                        User guide: create your own scikit-learn estimator
+                        User Guide
                       </a>
                     </li>
 
 
                     <li class="nav-item current active">
                       <a class="nav-link nav-internal" href="#">
-                        project-template API
+                        API Reference
                       </a>
                     </li>
 
 
                     <li class="nav-item">
                       <a class="nav-link nav-internal" href="auto_examples/index.html">
-                        General examples
+                        Example Gallery
                       </a>
                     </li>
 
@@ -378,7 +384,7 @@
         <i class="fa-solid fa-home"></i>
       </a>
     </li>
-    <li class="breadcrumb-item active" aria-current="page">project-template API</li>
+    <li class="breadcrumb-item active" aria-current="page">API Reference</li>
   </ul>
 </nav>
 </div>
@@ -395,8 +401,8 @@
 <div id="searchbox"></div>
                 <article class="bd-article">
 
-  <section id="project-template-api">
-<h1>project-template API<a class="headerlink" href="#project-template-api" title="Link to this heading">#</a></h1>
+  <section id="api-reference">
+<h1>API Reference<a class="headerlink" href="#api-reference" title="Link to this heading">#</a></h1>
 <p>This is an example on how to document the API of your own project.</p>
 <section id="estimator">
 <h2>Estimator<a class="headerlink" href="#estimator" title="Link to this heading">#</a></h2>
@@ -446,7 +452,7 @@ <h2>Predictor<a class="headerlink" href="#predictor" title="Link to this heading
       <i class="fa-solid fa-angle-left"></i>
       <div class="prev-next-info">
         <p class="prev-next-subtitle">previous</p>
-        <p class="prev-next-title">User guide: create your own scikit-learn estimator</p>
+        <p class="prev-next-title">User Guide</p>
       </div>
     </a>
     <a class="right-next"