project logo and variants

Author: big-o

README.rst

@@ -14,6 +14,8 @@
 skdag - A more flexible alternative to scikit-learn Pipelines
 =============================================================
 
+.. image:: img/skdag-banner.png
+
 scikit-dag (``skdag``) is an open-sourced, MIT-licenced library that provides advanced
 workflow management to any machine learning operations that follow
 scikit-learn_ conventions. Installation is simple:
@@ -88,4 +90,4 @@ executing local ensembles from estimators.
 
 `Read on <https://skdag.readthedocs.io/>`_ to learn more about ``skdag``...
 
-.. _scikit-learn: https://scikit-learn.org
+.. _scikit-learn: https://scikit-learn.org

doc/_static/css/project-template.css

@@ -14,3 +14,7 @@
 .deprecated p span.versionmodified {
     font-weight: bold;
 }
+
+img.logo {
+    max-height: 100px;
+}

doc/_static/img/skdag-banner.png

@@ -0,0 +1 @@
+../../../img/skdag-banner.png

doc/_static/img/skdag-dark.png

@@ -0,0 +1 @@
+../../../img/skdag-dark.png

doc/conf.py

@@ -143,7 +143,9 @@
 # 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 = {
+    "logo_only": True,
+}
 
 # Add any paths that contain custom themes here, relative to this directory.
 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
@@ -157,7 +159,7 @@
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-# html_logo = None
+html_logo = "_static/img/skdag-dark.png"
 
 # 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
@@ -316,10 +318,10 @@
 # intersphinx configuration
 intersphinx_mapping = {
     "python": ("https://docs.python.org/{.major}".format(sys.version_info), None),
-    "numpy": ("https://docs.scipy.org/doc/numpy/", None),
-    "scipy": ("https://docs.scipy.org/doc/scipy/reference", None),
-    "matplotlib": ("https://matplotlib.org/", None),
-    "sklearn": ("http://scikit-learn.org/stable", None),
+    "numpy": ("https://numpy.org/doc/stable", None),
+    "scipy": ("https://docs.scipy.org/doc/scipy", None),
+    "matplotlib": ("https://matplotlib.org/stable", None),
+    "sklearn": ("https://scikit-learn.org/stable", None),
 }
 
 # sphinx-gallery configuration

doc/index.rst

@@ -120,4 +120,4 @@ Detailed API documentation.
 `Examples <auto_examples/index.html>`_
 --------------------------------------
 
-Further examples that complement the `User Guide <user_guide.html>`_.
+Further examples that complement the `User Guide <user_guide.html>`_.