Merge branch 'pydeps' into 'master'

Pydeps in documentation

Closes #26

See merge request flatland/flatland!15

.gitlab-ci.yml

@@ -25,6 +25,7 @@ tests:
         - apt update
         - apt install -y libgl1-mesa-glx xvfb
         - pip install tox
+        - apt install -y graphviz xdg-utils
         - xvfb-run -s "-screen 0 800x600x24" tox
 
 build_and_deploy_docs:

Makefile

@@ -71,6 +71,7 @@ docs: ## generate Sphinx HTML documentation, including API docs
 	sphinx-apidoc -o docs/ flatland
 	$(MAKE) -C docs clean
 	$(MAKE) -C docs html
+	pydeps --no-config --noshow flatland -o docs/_build/html/flatland.svg
 	$(BROWSER) docs/_build/html/index.html
 
 servedocs: docs ## compile the docs watching for changes

README.rst

@@ -92,6 +92,10 @@ flatland
 ========
 TODO: explain the interface here
 
+Module Dependencies
+===================
+.. image:: flatland.svg
+
 
 Authors
 --------
@@ -102,6 +106,7 @@ Authors
 * Erik Nygren <erik.nygren@sbb.ch>
 * Adrian Egli <adrian.egli@sbb.ch>
 * Vaibhav Agrawal <theinfamouswayne@gmail.com>
+* Christian Eichenberger <christian.markus.eichenberger@sbb.ch>
 
 
 <please fill yourself in>

examples/temporary_example.py

 import random
 
-import numpy as np
-
 from flatland.envs.generators import random_rail_generator
 from flatland.envs.rail_env import RailEnv
 from flatland.utils.rendertools import RenderTool
+import numpy as np
 
 random.seed(0)
 np.random.seed(0)

make_docs.py

@@ -25,5 +25,6 @@ os.environ["SPHINXPROJ"] = "flatland"
 os.chdir('docs')
 subprocess.call(['python', '-msphinx', '-M', 'clean', '.', '_build'])
 subprocess.call(['python', '-msphinx', '-M', 'html', '.', '_build'])
+subprocess.call(['python', '-mpydeps', '../flatland', '-o', '_build/html/flatland.svg'])
 
 browser('_build/html/index.html')

requirements_dev.txt

@@ -2,6 +2,7 @@ bumpversion==0.5.3
 wheel==0.32.1
 watchdog==0.9.0
 flake8==3.5.0
+pydeps==1.7.2
 tox==3.5.2
 coverage==4.5.1
 Sphinx==1.8.1

tests/test_rendertools.py

@@ -4,18 +4,14 @@
 Tests for `flatland` package.
 """
 
-from flatland.envs.rail_env import RailEnv, random_rail_generator
-import numpy as np
-#<<<<<<< HEAD
-#=======
-# import os
-#>>>>>>> dc2fa1ee0244b15c76d89ab768c5e1bbd2716147
 import sys
 
 import matplotlib.pyplot as plt
+import numpy as np
 
 import flatland.utils.rendertools as rt
 from flatland.envs.observations import TreeObsForRailEnv
+from flatland.envs.rail_env import RailEnv, random_rail_generator
 
 
 def checkFrozenImage(oRT, sFileImage, resave=False):

tox.ini

@@ -13,7 +13,7 @@ ignore = E121 E126 E123 E128 E133 E226 E241 E242 E704 W291 W293 W391 W503 W504 W
 [testenv:flake8]
 basepython = python
 deps = flake8
-commands = flake8 flatland
+commands = flake8 flatland tests examples
 
 [testenv:docs]
 basepython = python