Manuel Goulão f7c17506b4 Update docs/README.md to link to a new CONTRIBUTING.md for docs (#309)		2 jaren geleden
..
_static	b7d447b34f Add updated favicon to documentation website (#299)	2 jaren geleden
api	eb9d4f6ee3 Documentation Update (#261)	2 jaren geleden
content	4988c174f0 Update publications.md (#294)	2 jaren geleden
environments	72873a133c Add generated Gifs and a grid with all environments (#274)	2 jaren geleden
scripts	88ebc71e9c Added Docstrings to the BabyAI envs (#302)	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	fc41b5e7c3 Some typing improvements, add py.typed (#284)	2 jaren geleden
index.md	d84588ff6e Adjust docs main page gif size (#277)	2 jaren geleden
make.bat	155ab4c8b7 Update Docs Makefile (#275)	2 jaren geleden
requirements.txt	eb9d4f6ee3 Documentation Update (#261)	2 jaren geleden

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

README.md

MiniGrid documentation

Editing an environment page

Build the Documentation