Manuel Goulão 1 vuosi sitten
vanhempi
commit
d1fd3bade2
3 muutettua tiedostoa jossa 10 lisäystä ja 2 poistoa
  1. BIN
      docs/_static/img/minigrid-github.png
  2. 4 1
      docs/conf.py
  3. 6 1
      docs/index.md

BIN
docs/_static/img/minigrid-github.png


+ 4 - 1
docs/conf.py

@@ -23,7 +23,7 @@ import sys
 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 @@ extensions = [
     "sphinx.ext.doctest",
     "sphinx.ext.autodoc",
     "sphinx.ext.githubpages",
+    "sphinx.ext.viewcode",
     "myst_parser",
     "sphinx_github_changelog",
 ]
@@ -77,6 +78,8 @@ html_favicon = "_static/img/minigrid-favicon.png"
 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/",

+ 6 - 1
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