diff --git a/Makefile b/Makefile index 98dcbb47a03ad7125694e5053f5e973e45b4fba4..625146c06526b97f607b2d33a81bfc2b2f67ceb2 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 a1bcf68c3c25076d21f6aaae94e58677e6ba5876..0000000000000000000000000000000000000000 --- 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 e5ac277f8d1e173f620e85a498ce950e5b1f3ad8..0000000000000000000000000000000000000000 --- 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 55df091d9b4a47d4ef0a6bb2d4f715f90dbb0a5a..0000000000000000000000000000000000000000 --- 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 acd396ca9de654f8eb40a35f50c7fe08498a2a31..0000000000000000000000000000000000000000 --- 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 022e8586b7933af4f7eac78a01168c27639c65c2..0000000000000000000000000000000000000000 --- 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 e09087a49b6df3572ac38b77e41ca739bcea8150..0000000000000000000000000000000000000000 --- 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 5858d2220fa9604b88bb5738b94593e9d83e7687..0000000000000000000000000000000000000000 --- 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 f1e80cb0966bdcaec344f91f489000f03f3797be..c38b78b5073f4c7830dd13b110f9a6f452171ba1 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