Adds tutorial stubs

andyljones · Jul 5, 2020 · 523a36c · 523a36c
1 parent 8810e37
commit 523a36c
Show file tree

Hide file tree

Showing 8 changed files with 57 additions and 11 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -0,0 +1,7 @@
+#################
+API Documentation
+#################
+
+.. automodule:: onedee.core
+    :members:
+    :undoc-members:
diff --git a/docs/conf.py b/docs/conf.py
@@ -10,10 +10,10 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
-# print(sys.path)
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..'))
+print(sys.path)
 
 
 # -- Project information -----------------------------------------------------
@@ -32,7 +32,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    "sphinx_rtd_theme",
+    'sphinx.ext.autodoc'
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -49,8 +49,19 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "sphinx_rtd_theme"
-
+html_theme = "alabaster"
+
+html_theme_options = {
+    'description': 'RL at 1m FPS'
+}
+
+html_sidebars = {
+    '**': [
+        'about.html',
+        'navigation.html',
+        'relations.html',
+    ]
+}
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

diff --git a/docs/index.rst b/docs/index.rst
@@ -3,10 +3,26 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to onedee's documentation!
-==================================
+######
+onedee
+######
 
+*********
+Tutorials
+*********
+.. toctree::
+   :maxdepth: 1
+
+   tutorials/env-minimal
+   tutorials/env-single-agent
+   tutorials/env-competitive
+   tutorials/train
+
+********
+API Docs
+********
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
-      test
+
+   api
+
diff --git a/docs/tutorials/env-competitive.rst b/docs/tutorials/env-competitive.rst
@@ -0,0 +1,3 @@
+##################################
+Building a Competitive Environment
+##################################
diff --git a/docs/tutorials/env-minimal.rst b/docs/tutorials/env-minimal.rst
@@ -0,0 +1,3 @@
+##############################
+Building a Minimal Environment
+##############################
diff --git a/docs/tutorials/env-single-agent.rst b/docs/tutorials/env-single-agent.rst
@@ -0,0 +1,3 @@
+###################################
+Building a Single-Agent Environment
+###################################
diff --git a/docs/tutorials/train.rst b/docs/tutorials/train.rst
@@ -0,0 +1,2 @@
+Training An Agent
+#################
diff --git a/onedee/core.py b/onedee/core.py
@@ -25,6 +25,7 @@ def select(x, d):
     return x.vals[s:e]
 
 class Core: 
+    """The core rendering and physics interface"""
 
     def __init__(self, geometries, n_agents=1, res=64, supersample=8, fov=130, fps=10):
         self.geometries = geometries