Feng eb9d4f6ee3 Documentation Update (#261) 2 lat temu
..
_static eb9d4f6ee3 Documentation Update (#261) 2 lat temu
api eb9d4f6ee3 Documentation Update (#261) 2 lat temu
content eb9d4f6ee3 Documentation Update (#261) 2 lat temu
environments eb9d4f6ee3 Documentation Update (#261) 2 lat temu
scripts eb9d4f6ee3 Documentation Update (#261) 2 lat temu
404.md f2a30bd1b2 Documentations (#242) 2 lat temu
LICENSE ffe57c9fbd Update setup, coc, license (#263) 2 lat temu
Makefile f2a30bd1b2 Documentations (#242) 2 lat temu
README.md f2a30bd1b2 Documentations (#242) 2 lat temu
conf.py eb9d4f6ee3 Documentation Update (#261) 2 lat temu
index.md eb9d4f6ee3 Documentation Update (#261) 2 lat temu
make.bat f2a30bd1b2 Documentations (#242) 2 lat temu
requirements.txt eb9d4f6ee3 Documentation Update (#261) 2 lat temu

README.md

MiniGrid-docs

This repo contains the [NEW website]() for MiniGrid. This site is currently in Beta and we are in the process of adding/editing information.

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

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 Gym (or your fork):

pip install -r requirements.txt
pip install gym

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 ./source build/html