Merge "Fix watcher doc build error"

doc/source/glossary.rst

@@ -228,7 +228,7 @@ Efficacy Indicator
 Efficacy Specification
 ======================
 
-.. watcher-term:: watcher.api.controllers.v1.efficacy_specification
+.. watcher-term:: watcher.decision_engine.goal.efficacy.base
 
 .. _efficacy_definition:
 

watcher/decision_engine/goal/goals.py

@@ -72,6 +72,11 @@ class Unclassified(base.Goal):
 
 
 class ServerConsolidation(base.Goal):
+    """ServerConsolidation
+
+    This goal is for efficient usage of compute server resources in order to
+    reduce the total number of servers.
+    """
 
     @classmethod
     def get_name(cls):
@@ -92,6 +97,10 @@ class ServerConsolidation(base.Goal):
 
 
 class ThermalOptimization(base.Goal):
+    """ThermalOptimization
+
+    This goal is used to balance the temperature across different servers.
+    """
 
     @classmethod
     def get_name(cls):
@@ -112,6 +121,10 @@ class ThermalOptimization(base.Goal):
 
 
 class WorkloadBalancing(base.Goal):
+    """WorkloadBalancing
+
+    This goal is used to evenly distribute workloads across different servers.
+    """
 
     @classmethod
     def get_name(cls):

watcher/doc.py

@@ -57,7 +57,7 @@ class BaseWatcherDirective(rst.Directive):
 
         if not obj_raw_docstring:
             # Raise a warning to make the tests fail wit doc8
-            raise self.error("No docstring available for this plugin!")
+            raise self.error("No docstring available for %s!" % obj)
 
         obj_docstring = inspect.cleandoc(obj_raw_docstring)
         self.add_textblock(obj_docstring)