- getting documentation ready for readthedocs.

- throwing out engine2learn client lib (replace by TensorForce)
ducandu · Dec 17, 2017 · ed534f5 · ed534f5
1 parent 94198ec
commit ed534f5
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -1,10 +1,10 @@
 # engine2learn
 Machine Learning Interface into the UE4 Game Engine.
 
-![Python](sven1977.github.com/engine2learn/images/python-logo.png)
-![Spark](sven1977.github.com/engine2learn/images/spark-logo.png)
-![TensorFlow](sven1977.github.com/engine2learn/images/tensorflow-logo.png)
-![UE4](sven1977.github.com/engine2learn/images/ue4-logo.png)
+![Python](sven1977.github.com/engine2learn/docs/images/python-logo.png)
+![Spark](sven1977.github.com/engine2learn/docs/images/spark-logo.png)
+![TensorFlow](sven1977.github.com/engine2learn/docs/images/tensorflow-logo.png)
+![UE4](sven1977.github.com/engine2learn/docs/images/ue4-logo.png)
 
 Connecting the Vagrant VM+Spark+Tensorflow world to the Game Dev world.
 
@@ -77,6 +77,21 @@ if __name__ == "__main__":
 ```
 
 
+### Cite
+
+If you use Engine2Learn in your academic research, we would be grateful if you could cite it as follows:
+
+```
+@misc{mika2017engine2learn,
+    author = {Mika, Sven and DeLoris, Roberto},
+    title = {Engine2Learn: Bringing Deep Reinforcement Learning to the Unreal Engine 4},
+    howpublished={Web page},
+    url = {https://github.com/ducandu/engine2learn},
+    year = {2017}
+}
+```
+
+
 # Unreal
 
 Having your project client compiled in your shared `/vagrant` directory, use `Vagrantfile-unreal` to start and provision the vagrant environment passing environment parameter, as in example below:

diff --git a/docs/conf.py b/docs/conf.py
@@ -22,7 +22,7 @@
 import sys
 sys.path.insert(0, os.path.abspath('../spygame'))
 sys.path.insert(0, os.path.abspath('../'))
-import engine2learn as el
+#import engine2learn as el
 
 
 # -- General configuration ------------------------------------------------
@@ -66,9 +66,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = el.VERSION_
+version = "0.1"
 # The full version, including alpha/beta/rc tags.
-release = el.RELEASE_
+release = "0.1a9"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/docs/index.rst b/docs/index.rst
@@ -21,7 +21,7 @@ Engine2Learn is a library for bringing reinforcement learning to the UnrealEngin
 
    readme_link.rst
    intro.rst
-   e2l_reference.rst
+..   e2l_reference.rst
 
 Indices and tables
 ==================