doc: Document OpTestError as deprecated

Signed-off-by: Stewart Smith <stewart@linux.vnet.ibm.com>

Author: stewartsmith

common/OpTestError.py

@@ -24,15 +24,15 @@
 #
 # IBM_PROLOG_END_TAG
 
-## @package OpTestError
-#  BMC package which contains all BMC related Errors
+"""
+A catch-all exception.
+
+Use of this exception is **DEPRECATED** and will be removed in the future.
+
+Some existing code uses this, and it should be gradually converted to use
+more specialized exceptions.
+"""
 
-#
-# @par Class description:
-# Exception Class, for the raising Bmc related Exceptions
-#
-# Attributes: @li ExceptionCode -- Code to indicate the error \n @li Reason -- explanation of the error
-##
 class OpTestError(Exception):
     pass
 

doc/programming.rst

@@ -11,6 +11,12 @@ Exceptions
    :members:
    :undoc-members:
 
+OpTestError
+^^^^^^^^^^^
+.. automodule:: common.OpTestError
+   :members:
+   :undoc-members:
+
 OPExpect
 --------