Merge pull request #64 from mgoulao/main

Add MO-Gymnasium logo to docs
Farama-Foundation · May 29, 2023 · 54a44aa · 54a44aa
2 parents 62e26a3 + 8921684
commit 54a44aa
Show file tree

Hide file tree

Showing 8 changed files with 172 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -2,8 +2,9 @@
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://pre-commit.com/)
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
-
-# MO-Gymnasium: Multi-Objective Reinforcement Learning Environments
+<p align="center">
+    <img src="docs/_static/img/MO-Gymnasium-text.png" width="500px"/>
+</p>
 
 <!-- start elevator-pitch -->
 

diff --git a/docs/_static/img/MO-Gymnasium-github.png b/docs/_static/img/MO-Gymnasium-github.png
diff --git a/docs/_static/img/MO-Gymnasium-text.png b/docs/_static/img/MO-Gymnasium-text.png
diff --git a/docs/_static/img/MO-Gymnasium-white.svg b/docs/_static/img/MO-Gymnasium-white.svg
diff --git a/docs/_static/img/MO-Gymnasium.svg b/docs/_static/img/MO-Gymnasium.svg
diff --git a/docs/_static/img/favicon.png b/docs/_static/img/favicon.png
diff --git a/docs/conf.py b/docs/conf.py
@@ -67,8 +67,10 @@
 html_copy_source = False
 html_favicon = "_static/img/favicon.png"
 html_theme_options = {
-    # "light_logo": "img/Minari.svg",
-    # "dark_logo": "img/Minari_White.svg",
+    "light_logo": "img/MO-Gymnasium.svg",
+    "dark_logo": "img/MO-Gymnasium-white.svg",
+    "description": "MO-Gymnasium is a standardized API and a suite of environments for multi-objective reinforcement learning (MORL)",
+    "image": "img/MO-Gymnasium-github.png",
     "versioning": True,
     "source_repository": "https://github.com/Farama-Foundation/MO-Gymnasium/",
     "source_branch": "main",

diff --git a/docs/index.md b/docs/index.md
@@ -34,7 +34,13 @@ Donate <https://farama.org/donations>
 
 ```
 
-# MO-Gymnasium is a standardized API and a suite of environments for multi-objective reinforcement learning (MORL)
+```{project-logo} _static/img/MO-Gymnasium-text.png
+:alt: MO-Gymnasium Logo
+```
+
+```{project-heading}
+MO-Gymnasium is a standardized API and a suite of environments for multi-objective reinforcement learning (MORL)
+```
 
 ```{figure} _static/mo_cheetah_rect.gif
    :alt: MO-HalfCheetah gif