|
@@ -1,14 +1,9 @@
|
|
|
-# MiniGrid-docs
|
|
|
+# MiniGrid documentation
|
|
|
|
|
|
|
|
|
-This repo contains the [NEW website]() for [MiniGrid](https://github.com/Farama-Foundation/MiniGrid). This site is currently in Beta and we are in the process of adding/editing information.
|
|
|
+This folder contains the documentation for MiniGrid.
|
|
|
|
|
|
-
|
|
|
-The documentation uses Sphinx. However, the documentation is written in regular md, NOT rst.
|
|
|
-
|
|
|
-If you are modifying a non-environment page or an atari environment page, please PR this repo. Otherwise, follow the steps below:
|
|
|
-
|
|
|
-## Instructions for modifying environment pages
|
|
|
+For more information about how to contribute to the documentation go to our [CONTRIBUTING.md](https://github.com/Farama-Foundation/Celshast/blob/main/CONTRIBUTING.md)
|
|
|
|
|
|
### Editing an environment page
|
|
|
|
|
@@ -18,11 +13,11 @@ Otherwise, fork Gym and edit the docstring in the environment's Python file. The
|
|
|
|
|
|
## Build the Documentation
|
|
|
|
|
|
-Install the required packages and Gym (or your fork):
|
|
|
+Install the required packages and Minigrid:
|
|
|
|
|
|
```
|
|
|
-pip install -r requirements.txt
|
|
|
-pip install gym
|
|
|
+pip install -r docs/requirements.txt
|
|
|
+pip install -e .
|
|
|
```
|
|
|
|
|
|
To build the documentation once:
|
|
@@ -36,5 +31,5 @@ To rebuild the documentation automatically every time a change is made:
|
|
|
|
|
|
```
|
|
|
cd docs
|
|
|
-sphinx-autobuild -b dirhtml ./source build/html
|
|
|
+sphinx-autobuild -b dirhtml . _build
|
|
|
```
|