From 0500d051a6d8d4c793e971b83f792f3673470030 Mon Sep 17 00:00:00 2001
From: u214892 <u214892@sbb.ch>
Date: Tue, 10 Sep 2019 00:14:54 +0200
Subject: [PATCH] #79 bugfix sphinx generated documentation #161 observation
documentation #159 documentation about new INFO
---
Makefile | 5 +--
docs/flatland.baselines.rst | 30 -----------------
docs/flatland.core.grid.rst | 62 ------------------------------------
docs/flatland.core.rst | 30 -----------------
docs/flatland.envs.rst | 22 -------------
docs/flatland.evaluators.rst | 46 --------------------------
docs/flatland.rst | 32 -------------------
docs/flatland.utils.rst | 10 ------
docs/index.rst | 6 ++--
9 files changed, 6 insertions(+), 237 deletions(-)
delete mode 100644 docs/flatland.baselines.rst
delete mode 100644 docs/flatland.core.grid.rst
delete mode 100644 docs/flatland.core.rst
delete mode 100644 docs/flatland.envs.rst
delete mode 100644 docs/flatland.evaluators.rst
delete mode 100644 docs/flatland.rst
delete mode 100644 docs/flatland.utils.rst
diff --git a/Makefile b/Makefile
index 98dcbb47..625146c0 100644
--- a/Makefile
+++ b/Makefile
@@ -67,10 +67,11 @@ coverage: ## check code coverage quickly with the default Python
$(BROWSER) htmlcov/index.html
docs: ## generate Sphinx HTML documentation, including API docs
- rm -f docs/flatland.rst
+ rm -f docs/flatland*.rst
rm -f docs/modules.rst
- sphinx-apidoc -o docs/ flatland
+ sphinx-apidoc --force -a -e -o docs/ flatland
$(MAKE) -C docs clean
+ cp *.md docs
$(MAKE) -C docs html
pydeps --no-config --noshow flatland -o docs/_build/html/flatland.svg
$(BROWSER) docs/_build/html/index.html
diff --git a/docs/flatland.baselines.rst b/docs/flatland.baselines.rst
deleted file mode 100644
index a1bcf68c..00000000
--- a/docs/flatland.baselines.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-flatland.baselines package
-==========================
-
-Submodules
-----------
-
-flatland.baselines.dueling\_double\_dqn module
-----------------------------------------------
-
-.. automodule:: flatland.baselines.dueling_double_dqn
- :members:
- :undoc-members:
- :show-inheritance:
-
-flatland.baselines.model module
--------------------------------
-
-.. automodule:: flatland.baselines.model
- :members:
- :undoc-members:
- :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: flatland.baselines
- :members:
- :undoc-members:
- :show-inheritance:
diff --git a/docs/flatland.core.grid.rst b/docs/flatland.core.grid.rst
deleted file mode 100644
index e5ac277f..00000000
--- a/docs/flatland.core.grid.rst
+++ /dev/null
@@ -1,62 +0,0 @@
-flatland.core.grid package
-==========================
-
-Submodules
-----------
-
-flatland.core.grid.grid4 module
--------------------------------
-
-.. automodule:: flatland.core.grid.grid4
- :members:
- :undoc-members:
- :show-inheritance:
-
-flatland.core.grid.grid4\_astar module
---------------------------------------
-
-.. automodule:: flatland.core.grid.grid4_astar
- :members:
- :undoc-members:
- :show-inheritance:
-
-flatland.core.grid.grid4\_utils module
---------------------------------------
-
-.. automodule:: flatland.core.grid.grid4_utils
- :members:
- :undoc-members:
- :show-inheritance:
-
-flatland.core.grid.grid8 module
--------------------------------
-
-.. automodule:: flatland.core.grid.grid8
- :members:
- :undoc-members:
- :show-inheritance:
-
-flatland.core.grid.grid\_utils module
--------------------------------------
-
-.. automodule:: flatland.core.grid.grid_utils
- :members:
- :undoc-members:
- :show-inheritance:
-
-flatland.core.grid.rail\_env\_grid module
------------------------------------------
-
-.. automodule:: flatland.core.grid.rail_env_grid
- :members:
- :undoc-members:
- :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: flatland.core.grid
- :members:
- :undoc-members:
- :show-inheritance:
diff --git a/docs/flatland.core.rst b/docs/flatland.core.rst
deleted file mode 100644
index 55df091d..00000000
--- a/docs/flatland.core.rst
+++ /dev/null
@@ -1,30 +0,0 @@
-flatland.core package
-=====================
-
-Submodules
-----------
-
-flatland.core.env module
-------------------------
-
-.. automodule:: flatland.core.env
- :members:
- :undoc-members:
- :show-inheritance:
-
-flatland.core.transitions module
---------------------------------
-
-.. automodule:: flatland.core.transitions
- :members:
- :undoc-members:
- :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: flatland.core
- :members:
- :undoc-members:
- :show-inheritance:
diff --git a/docs/flatland.envs.rst b/docs/flatland.envs.rst
deleted file mode 100644
index acd396ca..00000000
--- a/docs/flatland.envs.rst
+++ /dev/null
@@ -1,22 +0,0 @@
-flatland.envs package
-=====================
-
-Submodules
-----------
-
-flatland.envs.rail\_env module
-------------------------------
-
-.. automodule:: flatland.envs.rail_env
- :members:
- :undoc-members:
- :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: flatland.envs
- :members:
- :undoc-members:
- :show-inheritance:
diff --git a/docs/flatland.evaluators.rst b/docs/flatland.evaluators.rst
deleted file mode 100644
index 022e8586..00000000
--- a/docs/flatland.evaluators.rst
+++ /dev/null
@@ -1,46 +0,0 @@
-flatland.evaluators package
-===========================
-
-Submodules
-----------
-
-flatland.evaluators.aicrowd\_helpers module
--------------------------------------------
-
-.. automodule:: flatland.evaluators.aicrowd_helpers
- :members:
- :undoc-members:
- :show-inheritance:
-
-flatland.evaluators.client module
----------------------------------
-
-.. automodule:: flatland.evaluators.client
- :members:
- :undoc-members:
- :show-inheritance:
-
-flatland.evaluators.messages module
------------------------------------
-
-.. automodule:: flatland.evaluators.messages
- :members:
- :undoc-members:
- :show-inheritance:
-
-flatland.evaluators.service module
-----------------------------------
-
-.. automodule:: flatland.evaluators.service
- :members:
- :undoc-members:
- :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: flatland.evaluators
- :members:
- :undoc-members:
- :show-inheritance:
diff --git a/docs/flatland.rst b/docs/flatland.rst
deleted file mode 100644
index e09087a4..00000000
--- a/docs/flatland.rst
+++ /dev/null
@@ -1,32 +0,0 @@
-flatland package
-================
-
-Subpackages
------------
-
-.. toctree::
-
- flatland.core
- flatland.envs
- flatland.evaluators
- flatland.utils
-
-Submodules
-----------
-
-flatland.cli module
--------------------
-
-.. automodule:: flatland.cli
- :members:
- :undoc-members:
- :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: flatland
- :members:
- :undoc-members:
- :show-inheritance:
diff --git a/docs/flatland.utils.rst b/docs/flatland.utils.rst
deleted file mode 100644
index 5858d222..00000000
--- a/docs/flatland.utils.rst
+++ /dev/null
@@ -1,10 +0,0 @@
-flatland.utils package
-======================
-
-Module contents
----------------
-
-.. automodule:: flatland.utils
- :members:
- :undoc-members:
- :show-inheritance:
diff --git a/docs/index.rst b/docs/index.rst
index f1e80cb0..c38b78b5 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -9,15 +9,15 @@ Welcome to flatland's documentation!
installation
about_flatland
gettingstarted
- specifications/specifications.md
intro_observationbuilder
+ specifications/specifications.md
localevaluation
modules
FAQ
contributing
authors
- ../changelog.md
- ../flatland_2.0.md
+ changelog.md
+ flatland_2.0.md
--
GitLab