Update docs

zuoxingdong · Aug 7, 2019 · cf91231 · cf91231
1 parent c89d19b
commit cf91231
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 10 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -13,11 +13,10 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 import os
 import sys
+import mock
 sys.path.insert(0, os.path.abspath('../../'))
 
-
 # Exclude some dependencies for Read the Docs to compile with
-import mock
 MOCK_MODULES = ['seaborn', 
                 'matplotlib',
                 'matplotlib.pyplot',
@@ -59,8 +58,9 @@
 ]
 
 # Napoleon settings
-napoleon_include_init_with_doc = True  # show docstring of __init__
-napoleon_include_private_with_doc = True  # show docstring of _method
+napoleon_google_docstring = True
+napoleon_include_init_with_doc = False  # show docstring of __init__
+napoleon_include_private_with_doc = False  # show docstring of _method
 napoleon_include_special_with_doc = True  # show docstring of __method__
 napoleon_use_ivar = True  # show argument dtype with link
 
@@ -176,6 +176,3 @@
      author, 'lagom', 'One line description of project.',
      'Miscellaneous'),
 ]
-
-
-# -- Extension configuration -------------------------------------------------
diff --git a/docs/source/envs.rst b/docs/source/envs.rst
@@ -12,6 +12,9 @@ lagom.envs
 
 .. autoclass:: NormalizeReward
     :members:
+
+.. autoclass:: TimeStepEnv
+    :members:
 
 .. autoclass:: VecEnv
     :members:

diff --git a/docs/source/metric.rst b/docs/source/metric.rst
@@ -4,9 +4,6 @@ lagom.metric: Metrics
 .. automodule:: lagom.metric
 .. currentmodule:: lagom.metric
 
-.. autoclass:: Trajectory
-    :members:
-
 .. autofunction:: returns
 
 .. autofunction:: bootstrapped_returns