Change doclayout pydata

docs/requirements.txt

@@ -1,4 +1,4 @@
 sphinx
-sphinx_rtd_theme
 sphinx-gallery
 sphinx-toggleprompt
+pydata-sphinx-theme

docs/src/conf.py

@@ -14,8 +14,6 @@
 import sys
 from datetime import datetime
 
-import sphinx_rtd_theme
-
 import skmatter
 
 
@@ -87,19 +85,30 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = "sphinx_rtd_theme"
+html_theme = "pydata_sphinx_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-# html_theme_options = {}
+html_theme_options = {
+    "github_url": "https://github.com/scikit-learn-contrib/scikit-matter",
+    "use_edit_page_button": True,
+}
+
+html_context = {
+    "github_url": "https://github.com",
+    "github_user": "scikit-learn-contrib",
+    "github_repo": "scikit-matter",
+    "github_version": "main",
+    "doc_path": "docs/src",
+}
 
 # Add any paths that contain custom themes here, relative to this directory.
-html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+# html_theme_path = []
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-# html_title = None
+html_title = f"{project} v{release}"
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 # html_short_title = None

docs/src/getting-started.rst

@@ -8,6 +8,8 @@ our :ref:`installation` instructions for installing ``scikit-matter``.
 For a detailed explaination of the functionalities, please look at the
 :ref:`selection-api`
 
+.. _getting_started-selection:
+
 Features and Samples Selection
 ------------------------------
 
@@ -21,6 +23,8 @@ Notebook Examples
    :start-line: 4
 
 
+.. _getting_started-reconstruction:
+
 Reconstruction Measures
 -----------------------
 
@@ -33,6 +37,8 @@ Notebook Examples
 .. include:: examples/reconstruction/index.rst
    :start-line: 4
 
+.. _getting_started-pcovr:
+
 Principal Covariates Regression
 -------------------------------
 

docs/src/index.rst

@@ -1,12 +1,81 @@
 .. automodule:: skmatter
 
+.. raw:: html
+
+    <div class="container">
+        <div class="row">
+            <div class="col-sm d-flex">
+                <div class="card text-center mb-4" style="background-color: transparent">
+                <div class="card-body">
+                    <h5 class="card-title" style="margin-top: 0px">
+
+
+.. only:: html
+
+  :ref:`getting_started-selection`
+
+  .. image:: /examples/selection/images/thumb/sphx_glr_FeatureSelection-WHODataset_thumb.png
+    :alt:
+
+.. raw:: html
+
+                    </h5>
+                    <p class="card-text">Supervised and unsupervised selection
+                    methods based on
+                    CUR matrix decomposition and Farthest Point Sampling.</p>
+                </div>
+                </div>
+            </div>
+            <div class="col-sm d-flex">
+                <div class="card text-center mb-4" style="background-color: transparent">
+                <div class="card-body">
+                    <h5 class="card-title" style="margin-top: 0px">
+
+.. only:: html
+
+  :ref:`getting_started-pcovr`
+
+  .. image:: /examples/pcovr/images/thumb/sphx_glr_PCovR_thumb.png
+    :alt:
+
+.. raw:: html
+
+                    </h5>
+                    <p class="card-text">Utilises a combination between a PCA-like and a LR-like loss
+                    to determine the decomposition matrix to project feature into latent space</p>
+                </div>
+                </div>
+            </div>
+            <div class="col-sm d-flex">
+                <div class="card text-center mb-4" style="background-color: transparent">
+                <div class="card-body">
+                    <h5 class="card-title" style="margin-top: 0px">
+
+.. only:: html
+
+  :ref:`getting_started-reconstruction`
+
+  .. image:: /examples/reconstruction/images/thumb/sphx_glr_PlotLFRE_thumb.png
+    :alt:
+
+.. raw:: html
+
+                    </h5>
+                    <p class="card-text">Error measures for quantifying the
+                    linear decodable information capacity between features</p>
+                </div>
+                </div>
+            </div>
+        </div>
+    </div>
+    <br>
+
 .. include:: ../../README.rst
    :start-after: marker-issues
    :end-before: marker-contributing
 
 .. toctree::
-  :maxdepth: 1
-  :caption: Contents:
+  :hidden:
 
   getting-started
   installation