From a80c4b3e6706b1ccbcf5ce27d2c688944f1abc38 Mon Sep 17 00:00:00 2001 From: SP Mohanty <spmohanty91@gmail.com> Date: Wed, 3 Jul 2019 09:47:46 +0200 Subject: [PATCH] rename about page to avoid conflicts --- README.rst | 1 + docs/{about.rst => about_flatland.rst} | 5 +++++ docs/index.rst | 2 +- 3 files changed, 7 insertions(+), 1 deletion(-) rename docs/{about.rst => about_flatland.rst} (98%) diff --git a/README.rst b/README.rst index 65ac1949..9bc53c7b 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 ce075205..84f2e329 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 c1945553..47201ffd 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 -- GitLab