Add apidoc back to flatland book.

.github/workflows/checks.yml

@@ -0,0 +1,26 @@
+name: Checks
+
+on:
+  pull_request:
+    branches: [ "main" ]
+
+concurrency:
+  group: ${{ github.head_ref }}
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-22.04
+    steps:
+      -   uses: actions/checkout@v4
+      -   name: Set up Python
+          uses: actions/setup-python@v5
+          with:
+            python-version: "3.10"
+      -   name: Build
+          run: |
+            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 .

.github/workflows/main.yml

@@ -20,8 +20,11 @@ jobs:
                     python-version: "3.10"
             -   name: Build
                 run: |
-                    pip install -U "jupyter-book>=0.11.2"
-                    jupyter-book build .
+                  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 .
             # https://github.com/actions/upload-pages-artifact
             - name: Upload GitHub Pages artifact
               uses: actions/[email protected]        

README.md

@@ -1,25 +1,34 @@
 # Contribute to Flatland Book
 
-This repository is an aggregation of all the documentation, exploratory research, baselines, un-explored ideas, future research directions for the [Flatland-RL](https://github.com/flatland-association/flatland-rl/) project.
+[Flatland Book](https://flatland-association.github.io/flatland-book/) is an aggregation of all the documentation, exploratory research, baselines, un-explored
+ideas, future research directions for
+the [Flatland-RL](https://github.com/flatland-association/flatland-rl/) project.
 
 # Installation
 
-```
+```shell
 git clone https://github.com/flatland-association/flatland-book.git 
 
-pip install -U "jupyter-book>=0.11.2"
+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:
+Changes to the ToC will require full re-build by running
 
-```
-clear; jupyter-book clean .; jupyter-book build .
+```shell
+jupyter-book clean .
 ```
 
 # Author(s)
 
--   Sharada Mohanty
--   Florian Laurent
--   Nimish Santhosh
+- Sharada Mohanty
+- Florian Laurent
+- Nimish Santhosh
+- Erik Nygren
+- Adrian Egli
+- Manuel Schneider
+- Christian Eichenberger

_toc.yml

@@ -30,14 +30,14 @@ parts:
   - file: environment/pettingzoo
   - file: environment/Agent-Close-Following
   - file: environment/graph_demo
-  # - file: _sources/flatland/docs/10_interface_toc.rst
 
-# - caption: Environment Documentation
-#   chapters:
-#   - file: _sources/flatland/docs/index
+## APIDOC
+- caption: APIDOC
+  chapters:
+   - file: apidocs/index
 
 ## TUTORIALS
-- caption: Turorials
+- caption: Tutorials
   chapters:
   - file: tutorials/or
     # sections: