Bolun 367e1f5e29 Added Tutorial for Environment Creation (#348) 2 jaren geleden
..
_static b7d447b34f Add updated favicon to documentation website (#299) 2 jaren geleden
api 9677ebc899 Bug fix in DirectionObsWrapper, new tests, & name change (#310) 2 jaren geleden
content 367e1f5e29 Added Tutorial for Environment Creation (#348) 2 jaren geleden
environments 72873a133c Add generated Gifs and a grid with all environments (#274) 2 jaren geleden
scripts 97d32485e8 Rename move 404 script (#320) 2 jaren geleden
404.md f2a30bd1b2 Documentations (#242) 2 jaren geleden
LICENSE ffe57c9fbd Update setup, coc, license (#263) 2 jaren geleden
Makefile 155ab4c8b7 Update Docs Makefile (#275) 2 jaren geleden
README.md f7c17506b4 Update docs/README.md to link to a new CONTRIBUTING.md for docs (#309) 2 jaren geleden
conf.py d8c2db8c26 Fix missing edit button (#344) 2 jaren geleden
index.md 367e1f5e29 Added Tutorial for Environment Creation (#348) 2 jaren geleden
make.bat 155ab4c8b7 Update Docs Makefile (#275) 2 jaren geleden
release_notes.md 884c84ffd5 Add docs versioning and release notes (#319) 2 jaren geleden
requirements.txt 488b25db0d Add missing requirement to docs/requirements.txt (#329) 2 jaren geleden

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 md 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_mds.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