added parameters into docs

roocs · Oct 19, 2020 · e4f336b · e4f336b
1 parent 7a020d4
commit e4f336b
Show file tree

Hide file tree

Showing 6 changed files with 7 additions and 21 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -35,6 +35,12 @@ Parameters
    :undoc-members:
    :show-inheritance:
 
+.. automodule:: roocs_utils.parameter.parameterise
+   :noindex:
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 
 Xarray Utils
 ============

diff --git a/docs/conf.py b/docs/conf.py
@@ -94,13 +94,12 @@
 #
 # html_theme_options = {}
 
-html_logo = "_static/roocs.png"
 
 # 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,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_build/html/_static"]
-
+html_logo = "_static/roocs.png"
 
 # -- Options for HTMLHelp output ---------------------------------------
 

diff --git a/roocs_utils/parameter/area_parameter.py b/roocs_utils/parameter/area_parameter.py
@@ -15,11 +15,6 @@ class AreaParameter(_BaseParameter):
 
     Validates the area input and parses the values into numbers.
 
-    Methods
-    -------
-    tuple(self): Returns a tuple of the area values (property)
-    asdict(self): Returns a dictionary of the area values
-
     """
 
     parse_method = "_parse_sequence"

diff --git a/roocs_utils/parameter/collection_parameter.py b/roocs_utils/parameter/collection_parameter.py
@@ -15,10 +15,6 @@ class CollectionParameter(_BaseParameter):
 
     Validates the input and parses the ids.
 
-    Methods
-    -------
-    tuple(self): Returns a tuple of the collection ids (property)
-
     """
 
     parse_method = "_parse_sequence"

diff --git a/roocs_utils/parameter/level_parameter.py b/roocs_utils/parameter/level_parameter.py
@@ -21,11 +21,6 @@ class LevelParameter(_BaseParameter):
 
     Validates the level input and parses the values into numbers.
 
-    Methods
-    -------
-    tuple(self): Returns a tuple of the level values (property)
-    asdict(self): Returns a dictionary of the level values
-
     """
 
     parse_method = "_parse_range"

diff --git a/roocs_utils/parameter/time_parameter.py b/roocs_utils/parameter/time_parameter.py
@@ -22,11 +22,6 @@ class TimeParameter(_BaseParameter):
 
     Validates the times input and parses the values into isoformat.
 
-    Methods
-    -------
-    tuple(self): Returns a tuple of the time values (property)
-    asdict(self): Returns a dictionary of the time values
-
     """
 
     parse_method = "_parse_range"