Update documentation

Author: chrisleaman

docs/conf.py

@@ -10,9 +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('.'))
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath("../py_wave_runup/"))
 
 
 # -- Project information -----------------------------------------------------
@@ -26,11 +27,10 @@
 
 
 # -- General configuration ---------------------------------------------------
-
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = []
+extensions = ["sphinx.ext.autodoc"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
@@ -43,6 +43,10 @@
 # The master toctree document.
 master_doc = "index"
 
+source_suffix = ".rst"
+autoclass_content = "both"
+
+
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
@@ -54,3 +58,15 @@
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
+
+pygments_style = "sphinx"
+
+
+def autodoc_skip_member(app, what, name, obj, skip, options):
+    exclusions = ("RunupModel",)
+    exclude = name in exclusions
+    return skip or exclude
+
+
+def setup(app):
+    app.connect("autodoc-skip-member", autodoc_skip_member)

docs/index.rst

@@ -10,6 +10,9 @@ Welcome to py-wave-runup's documentation!
    :maxdepth: 2
    :caption: Contents:
 
+.. automodule:: models
+   :members:
+   :undoc-members:
 
 
 Indices and tables

py_wave_runup/models.py

@@ -13,6 +13,15 @@ class RunupModel(object):
     doi = None
 
     def __init__(self, Hs=None, Tp=None, beta=None, Lp=None):
+        """
+        Test
+
+        :param Hs: description
+        :param Tp: description
+        :param beta: description
+        :param Lp: description
+        """
+
         self.Hs = Hs
         self.Tp = Tp
         self.beta = beta