Update docs

zuoxingdong · Aug 24, 2018 · dd22ef1 · dd22ef1
1 parent 7929c8c
commit dd22ef1
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 3 deletions.
diff --git a/.gitignore b/.gitignore
@@ -16,7 +16,7 @@ __pycache__/
 .ipynb_checkpoints/
 
 # Read the Docs
-/docs/build/
+/doc/build
 
 
 

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -64,6 +64,12 @@
     'sphinx.ext.napoleon'  # Support Google Style docstring, i.e. Args/Returns
 ]
 
+# Napoleon settings
+napoleon_include_init_with_doc = True  # show docstring of __init__
+napoleon_include_private_with_doc = True  # show docstring of _method
+napoleon_include_special_with_doc = True  # show docstring of __method__
+napoleon_use_ivar = True  # show argument dtype with link
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['ntemplates']
 

diff --git a/lagom/utils.py b/lagom/utils.py
@@ -28,8 +28,7 @@ class Seeder(object):
     """
 
     def __init__(self, init_seed=0):
-        r"""Constructor.
-        
+        r"""
         Args:
             init_seed (int, optional): Initial seed for generating random seeds.
         """