docs: add evox logo

docs: add sphinx-favicon as a dependency
EMI-Group · Aug 3, 2023 · 9fb800b · 9fb800b
1 parent b386dec
commit 9fb800b
Show file tree

Hide file tree

Showing 8 changed files with 17 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,5 @@
 <h1 align="center">
-  <img src=./logo.png alt="Logo" height="24em"/>
+  <img src=./docs/source/_static/evox_logo.png alt="Logo" height="24em"/>
   <strong>EvoX</strong>
   <br>
   A Distributed GPU-accelerated Library towards Scalable Evolutionary Computation

diff --git a/docs/source/_static/evox.css b/docs/source/_static/evox.css
@@ -4,11 +4,11 @@ original css file: https://raw.githubusercontent.com/numpy/numpy/main/doc/source
 */
 
 .navbar-brand img {
-  height: 75px;
+  height: 100%;
 }
 
 .navbar-brand {
-  height: 75px;
+  height: 100%;
 }
 
 body {

diff --git a/logo.png → docs/source/_static/evox_logo.png b/logo.png → docs/source/_static/evox_logo.png
diff --git a/docs/source/_static/evox_logo_with_title.svg b/docs/source/_static/evox_logo_with_title.svg
diff --git a/docs/source/_static/favicon-16x16.ico b/docs/source/_static/favicon-16x16.ico
diff --git a/docs/source/_static/favicon-32x32.ico b/docs/source/_static/favicon-32x32.ico
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -37,6 +37,7 @@
     "sphinx.ext.napoleon",
     "sphinx_copybutton",
     "sphinx_design",
+    "sphinx_favicon",
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -63,10 +64,19 @@
 # a list of builtin themes.
 #
 html_theme = "pydata_sphinx_theme"
-
+html_logo = "_static/evox_logo_with_title.svg"
 html_theme_options = {
     "github_url": "https://github.com/EMI-Group/evox",
+    "logo": {
+        "alt_text": "EvoX logo image",
+        "text": "",
+    },
 }
+favicons = [
+    "favicon-16x16.ico",
+    "favicon-32x32.ico",
+]
+
 
 # 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,

diff --git a/requirements/docs-requirements.txt b/requirements/docs-requirements.txt
@@ -9,4 +9,5 @@ sphinx
 numpydoc
 myst-parser
 sphinx_copybutton
-sphinx_design
+sphinx_design
+sphinx-favicon