diff --git a/README.rst b/README.rst index 65ac19497be6ff99844e11e12a75e006b4f055e3..9bc53c7b0b193b63a137b1c277e9f29a8070bccb 100644 --- a/README.rst +++ b/README.rst @@ -27,6 +27,7 @@ This library was developed specifically for the `Flatland Challenge <https://www Contents =========== * `Official Documentation <http://flatland-rl-docs.s3-website.eu-central-1.amazonaws.com/readme.html>`_ +* `About Flatland <http://flatland-rl-docs.s3-website.eu-central-1.amazonaws.com/about_flatland.html>`_ * `Installation <http://flatland-rl-docs.s3-website.eu-central-1.amazonaws.com/installation.html>`_ * `Getting Started <http://flatland-rl-docs.s3-website.eu-central-1.amazonaws.com/gettingstarted.html>`_ * `Frequently Asked Questions <http://flatland-rl-docs.s3-website.eu-central-1.amazonaws.com/FAQ.html>`_ diff --git a/docs/about.rst b/docs/about_flatland.rst similarity index 98% rename from docs/about.rst rename to docs/about_flatland.rst index ce0752051da24cd951b0e6427faf2106360dd04f..84f2e329daf41579c8dffa4836387e5ac8f058f5 100644 --- a/docs/about.rst +++ b/docs/about_flatland.rst @@ -1,6 +1,11 @@ +About Flatland +============== + .. image:: https://i.imgur.com/rKGEmsk.gif :align: center + + Flatland is a toolkit for developing and comparing multi agent reinforcement learning algorithms on grids. The base environment is a two-dimensional grid in which many agents can be placed. Each agent must solve one or more tasks in the grid world. In general, agents can freely navigate from cell to cell. However, cell-to-cell navigation can be restricted by transition maps. diff --git a/docs/index.rst b/docs/index.rst index c194555350d3d50bb1fe71f54a32ef4e321bba57..47201ffd35914052e3fde0a72a5d393f33c419e1 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,8 +6,8 @@ Welcome to flatland's documentation! :caption: Contents: readme - about installation + about_flatland gettingstarted modules FAQ