DOC improve landing page

.gitignore

@@ -67,4 +67,9 @@ doc/sg_execution_times.rst
 # PyBuilder
 target/
 
-.pixi
+.pixi
+
+# General
+.DS_Store
+.AppleDouble
+.LSOverride

doc/api.rst

@@ -1,6 +1,6 @@
-####################
-project-template API
-####################
+#############
+API Reference
+#############
 
 This is an example on how to document the API of your own project.
 

doc/conf.py

@@ -42,17 +42,16 @@
 html_theme = "pydata_sphinx_theme"
 html_static_path = ["_static"]
 html_style = "css/project-template.css"
-# html_logo = "_static/img/logo.png"
+html_logo = "_static/img/logo.png"
 # html_favicon = "_static/img/favicon.ico"
 html_css_files = [
     "css/project-template.css",
 ]
-# html_sidebars = {
-#     "install": [],
-#     "auto_examples/index": [],
-#     "whats_new": [],
-#     "about": [],
-# }
+html_sidebars = {
+    "quick_start": [],
+    "user_guide": [],
+    "auto_examples/index": [],
+}
 
 html_theme_options = {
     "external_links": [],

doc/index.rst

@@ -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

doc/quick_start.rst

@@ -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.

doc/user_guide.rst

@@ -2,9 +2,9 @@
 
 .. _user_guide:
 
-==================================================
-User guide: create your own scikit-learn estimator
-==================================================
+==========
+User Guide
+==========
 
 Estimator
 ---------

examples/README.txt

@@ -1,6 +1,6 @@
 .. _general_examples:
 
-General examples
-================
+Example Gallery
+===============
 
 Introductory examples.