Simon Ouellette dd42847e86 New publication (#432) 11 mēneši atpakaļ
..
_scripts bdb182fce5 pre-commit autoupdate (#413) 1 gadu atpakaļ
_static ceb80ec1fd Pull env attributes to docs (#362) 1 gadu atpakaļ
api f3869ebc02 Updating wrappers documentation (#415) 1 gadu atpakaļ
content dd42847e86 New publication (#432) 11 mēneši atpakaļ
environments 72873a133c Add generated Gifs and a grid with all environments (#274) 2 gadi atpakaļ
404.md f2a30bd1b2 Documentations (#242) 2 gadi atpakaļ
LICENSE ffe57c9fbd Update setup, coc, license (#263) 2 gadi atpakaļ
Makefile 155ab4c8b7 Update Docs Makefile (#275) 2 gadi atpakaļ
README.md ceb80ec1fd Pull env attributes to docs (#362) 1 gadu atpakaļ
conf.py d1fd3bade2 Update docs (#352) 2 gadi atpakaļ
index.md 546c040a94 Add Training Tutorial and CITATION.cff (#379) 1 gadu atpakaļ
make.bat 155ab4c8b7 Update Docs Makefile (#275) 2 gadi atpakaļ
release_notes.md 884c84ffd5 Add docs versioning and release notes (#319) 2 gadi atpakaļ
requirements.txt 110672c025 Update docs to Sphinx latest version (#368) 1 gadu atpakaļ

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