[doc] Re-enable nitpicky mode; Fix broken docs

beat/backend/python/dataformat.py

@@ -119,7 +119,7 @@ class DataFormat(object):
       storage (object): A simple object that provides information about file
         paths for this dataformat
 
-      errors (list of str): A list containing errors found while loading this
+      errors (list): A list strings containing errors found while loading this
         dataformat.
 
       data (dict): The original data for this dataformat, as loaded by our JSON

beat/backend/python/execution/loop.py

@@ -71,7 +71,7 @@ class LoopChannel(object):
         """ Setup the channel internals
 
         Parameters:
-            algorithm (:py:class:`algorithm.Algorithm`) : algorithm for which
+            algorithm (:py:class:`.algorithm.Algorithm`) : algorithm for which
               the communication channel is setup.
 
             prefix (str) : Folder were the prefix is located.

beat/backend/python/execution/messagehandlers.py

@@ -348,7 +348,7 @@ class LoopMessageHandler(MessageHandler):
         """ Setup the loop internals
 
         Parameters:
-            algorithm (:py:class:`algorithm.Algorithm`) : algorithm for which
+            algorithm (:py:class:`.algorithm.Algorithm`) : algorithm for which
               the communication channel is setup.
 
             prefix (str) : Folder were the prefix is located.
@@ -364,7 +364,7 @@ class LoopMessageHandler(MessageHandler):
         """ Set the executor for validation
 
         Parameters:
-            executor (:py:class:`.Executor`) : Loop executor
+            executor (:py:class:`.loop.LoopExecutor`) : Loop executor
         """
         self.executor = executor
 
@@ -376,7 +376,8 @@ class LoopMessageHandler(MessageHandler):
         Syntax: val
 
         Parameters:
-            result (:py:class:`dataformat.DataFormat`) : Result to be validated.
+            result (:py:class:`beat.backend.python.dataformat.DataFormat`) :
+              Result to be validated.
         """
 
         result = result.encode("utf-8")

doc/conf.py

@@ -30,7 +30,7 @@ extensions = [
     ]
 
 # Be picky about warnings
-nitpicky = False
+nitpicky = True
 
 # Ignores stuff we can't easily resolve on other project's sphinx manuals
 nitpick_ignore = []
@@ -257,7 +257,8 @@ def member_function_test(app, what, name, obj, skip, options):
   if len(name) > 1 and name[0] == '_':
     # test if this private function should be allowed
     if name not in accepted_private_functions:
-      # omit privat functions that are not in the list of accepted private functions
+      # omit private functions that are not in the list of accepted private
+      # functions
       return skip
     else:
       # test if the method is documented