fixing doc stings for neat look

Author: ccluri

docs/source/DOCUMENTATION.rst

@@ -9,38 +9,45 @@ KCSD Methods
 
 .. automodule:: kcsd.KCSD
    :members:
+   :inherited-members:
 
 .. autoclass:: kcsd.sKCSD
    :members:
-      
+   :inherited-members:      
 
 Spectral Structure
 ~~~~~~~~~~~~~~~~~~
 
 .. autoclass:: kcsd.validation.ValidateKCSD.SpectralStructure
    :members:
+   :inherited-members:            
 
 Validation
 ~~~~~~~~~~
 
 .. autoclass:: kcsd.validation.ValidateKCSD.ValidateKCSD
    :members:
+   :inherited-members:            
 
 .. autoclass:: kcsd.validation.ValidateKCSD.ValidateKCSD1D
    :members:
+   :inherited-members:      
 
 .. autoclass:: kcsd.validation.ValidateKCSD.ValidateKCSD2D
    :members:
-		
+   :inherited-members:
+      
 .. autoclass:: kcsd.validation.ValidateKCSD.ValidateKCSD3D
    :members:
-
+   :inherited-members:
+      
 Reliability Maps
 ~~~~~~~~~~~~~~~~
 
 .. automodule:: kcsd.validation.VisibilityMap
    :members:
-
+   :inherited-members:
+      
 Basis functions
 ~~~~~~~~~~~~~~~
 

docs/source/conf.py

@@ -32,9 +32,12 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = ['sphinx.ext.autodoc',
-    'sphinx.ext.coverage',
-    'sphinx.ext.viewcode']
+              'sphinx.ext.coverage',
+              'sphinx.ext.viewcode',
+              'sphinx.ext.autosummary',
+              'numpydoc',]
 
+# numpydoc_show_class_members = False
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
@@ -49,8 +52,8 @@
 
 # General information about the project.
 project = 'kCSD-python'
-copyright = '2019, Chintaluri et.al.'
-author = 'Chintaluri et.al.'
+copyright = '2019, Chintaluri et.al'
+author = 'Chintaluri et.al'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -172,3 +175,10 @@
 
 
 
+def skip(app, what, name, obj, would_skip, options):
+    if name == "__init__":
+        return False
+    return would_skip
+
+def setup(app):
+    app.connect("autodoc-skip-member", skip)

docs/source/index.rst

@@ -7,7 +7,7 @@ Welcome to kCSD-python's documentation!
 =======================================
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
    :caption: Contents:
 
    INSTALL
@@ -21,5 +21,4 @@ Indices and tables
 ==================
 
 * :ref:`genindex`
-* :ref:`modindex`
 * :ref:`search`