Update docs (#352)

Farama-Foundation · May 14, 2023 · d1fd3ba · d1fd3ba
1 parent 26b4f64
commit d1fd3ba
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 2 deletions.
diff --git a/docs/_static/img/minigrid-github.png b/docs/_static/img/minigrid-github.png
diff --git a/docs/conf.py b/docs/conf.py
@@ -23,7 +23,7 @@
 import minigrid
 
 project = "MiniGrid"
-copyright = "2022"
+copyright = "2023 Farama Foundation"
 author = "Farama Foundation"
 
 # The full version, including alpha/beta/rc tags
@@ -41,6 +41,7 @@
     "sphinx.ext.doctest",
     "sphinx.ext.autodoc",
     "sphinx.ext.githubpages",
+    "sphinx.ext.viewcode",
     "myst_parser",
     "sphinx_github_changelog",
 ]
@@ -77,6 +78,8 @@
 html_theme_options = {
     "light_logo": "img/minigrid.svg",
     "dark_logo": "img/minigrid-white.svg",
+    "image": "img/minigrid-github.png",
+    "description": "Minigrid contains simple and easily configurable grid world environments to conduct Reinforcement Learning research. This library was previously known as gym-minigrid.",
     "gtag": "G-FBXJQQLXKD",
     "versioning": True,
     "source_repository": "https://github.com/Farama-Foundation/Minigrid/",

diff --git a/docs/index.md b/docs/index.md
@@ -4,8 +4,13 @@ firstpage:
 lastpage:
 ---
 
-## Minigrid contains simple and easily configurable grid world environments to conduct Reinforcement Learning research. This library was previously known as gym-minigrid.
+```{project-logo} _static/img/minigrid-text.svg
+:alt: Minigrid Logo
+```
 
+```{project-heading}
+Minigrid contains simple and easily configurable grid world environments to conduct Reinforcement Learning research. This library was previously known as gym-minigrid.
+```
 
 ```{figure} ../figures/door-key-curriculum.gif
    :alt: door key environment gif