You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
sp 68f01f6a3c added py versions of notebooks 21 hours ago
..
_scripts initial commit 2 months ago
_static initial commit 2 months ago
api initial commit 2 months ago
content initial commit 2 months ago
environments initial commit 2 months ago
404.md initial commit 2 months ago
LICENSE initial commit 2 months ago
Makefile initial commit 2 months ago
README.md initial commit 2 months ago
conf.py initial commit 2 months ago
index.md initial commit 2 months ago
make.bat initial commit 2 months ago
release_notes.md initial commit 2 months ago
requirements.txt initial commit 2 months ago

README.md

MiniGrid documentation

This folder contains the documentation for MiniGrid.

For more information about how to contribute to the documentation go to our CONTRIBUTING.md

Editing an environment page

If you are editing an Atari environment, directly edit the Markdown file in this repository.

Otherwise, fork Gym and edit the docstring in the environment's Python file. Then, pip install your Gym fork and run docs/_scripts/gen_env_docs.py in this repo. This will automatically generate a md documentation file for the environment.

Build the Documentation

Install the required packages and Minigrid:

pip install -r docs/requirements.txt
pip install -e .

To build the documentation once:

cd docs
make dirhtml

To rebuild the documentation automatically every time a change is made:

cd docs
sphinx-autobuild -b dirhtml . _build