Contribute to Flatland Book

Flatland Book is an aggregation of all the documentation, exploratory research, baselines, un-explored ideas, future research directions for the Flatland-RL project.

Installation

git clone https://github.com/flatland-association/flatland-book.git 

pip install -U "jupyter-book>=0.11.2" sphinxcontrib-apidoc flatland-rl

FLATLAND_MODULE_PATH=$(python -c 'import os; import importlib; print(os.path.dirname(importlib.import_module("flatland").__file__))')
FLATLAND_MODULE_VERSION=$(python -c "import flatland; print(flatland.__version__)")
sphinx-apidoc --force -a -e -o apidocs ${FLATLAND_MODULE_PATH}  -H "Flatland ${FLATLAND_MODULE_VERSION} API Reference" --tocfile 'index'
jupyter-book build .

Changes to the ToC will require full re-build by running

jupyter-book clean .

Author(s)

• Sharada Mohanty
• Florian Laurent
• Nimish Santhosh
• Erik Nygren
• Adrian Egli
• Manuel Schneider
• Christian Eichenberger