diff --git a/README.md b/README.md index 2dfe23f1e..6e46f098b 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,9 @@
-# ``skglm`` +skglm logo ## A fast ⚡ and modular ⚒️ scikit-learn replacement for sparse GLMs -
- ![build](https://github.com/scikit-learn-contrib/skglm/workflows/pytest/badge.svg) ![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg) [![Downloads](https://static.pepy.tech/badge/skglm)](https://pepy.tech/project/skglm) @@ -13,6 +11,9 @@ [![PyPI version](https://badge.fury.io/py/skglm.svg)](https://pypi.org/project/skglm/) + + + ``skglm`` is a Python package that offers **fast estimators** for sparse Generalized Linear Models (GLMs) that are **100% compatible with ``scikit-learn``**. It is **highly flexible** and supports a wide range of GLMs. You get to choose from ``skglm``'s already-made estimators or **customize your own** by combining the available datafits and penalties. diff --git a/doc/_static/images/logo.svg b/doc/_static/images/logo.svg new file mode 100644 index 000000000..415e08a9d --- /dev/null +++ b/doc/_static/images/logo.svg @@ -0,0 +1,10 @@ + + + + + + + + + + diff --git a/doc/conf.py b/doc/conf.py index 1941a92aa..58bf930e0 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -158,14 +158,14 @@ # documentation. html_theme_options = { "light_css_variables": { - "color-brand-primary": "#b91c1c", - "color-brand-content": "#b91c1c", + "color-brand-primary": "#991b1b", + "color-brand-content": "#991b1b", "font-stack": 'ui-sans-serif, system-ui', - "color-background-secondary": "#fef2f2" + "color-background-secondary": "#fafafa" }, "dark_css_variables": { - "color-brand-primary": "#f87171", - "color-brand-content": "#f87171", + "color-brand-primary": "#fca5a5", + "color-brand-content": "#fca5a5", }, "footer_icons": [ { @@ -215,12 +215,12 @@ # The name of an image file (relative to this directory) to place at the top # of the sidebar. -#html_logo = None +html_logo = "_static/images/logo.svg" # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -#html_favicon = None +html_favicon = "_static/images/logo.svg" # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files,