docs: switch to furo theme

jolars · Dec 11, 2023 · 6006fd9 · 6006fd9
1 parent b94c9b1
commit 6006fd9
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -32,7 +32,7 @@
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = "sphinx_rtd_theme"
+html_theme = "furo"
 html_static_path = ["_static"]
 
 # -- Options for napoleon extension ------------------------------------------

diff --git a/pyproject.toml b/pyproject.toml
@@ -30,7 +30,7 @@ Homepage = "https://jolars.github.io/sortedl1/"
 Source = "https://github.com/jolars/sortedl1"
 
 [project.optional-dependencies]
-docs = ["sphinx", "sphinx_rtd_theme"]
+docs = ["sphinx", "furo"]
 
 [tool.scikit-build]
 build-dir = "build/{wheel_tag}"

diff --git a/sortedl1/estimators.py b/sortedl1/estimators.py
@@ -36,6 +36,12 @@ class Slope(BaseEstimator, RegressorMixin):
         The estimated regression coefficients in a dense format.
     lambda_ : ndarray
         The lambda parameter vector for the Sorted L1 Penalty.
+    lambda_ : float
+        The value of alpha used.
+    n_iter_ : int
+        The total number of iterations from the inner loop.
+    n_features_in_ : int
+        The number of features seen by the estimator.
     """
 
     def __init__(