Merge branch 'nitpicky' into 'master'

Nitpicky documentation

See merge request !38

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,8 +71,8 @@ class LoopChannel(object):
         """ Setup the channel internals
 
         Parameters:
-            algorithm (:py:class:`algorithm.Algorithm`) : algorithm for which
-            the communication channel is setup.
+            algorithm (:py:class:`.algorithm.Algorithm`) : algorithm for which
+              the communication channel is setup.
 
             prefix (str) : Folder were the prefix is located.
         """
@@ -89,7 +89,7 @@ class LoopChannel(object):
 
         Parameters:
             hypothesis (dict) : Computed hypothesis that must be validated by
-            the loop algorithm.
+              the loop algorithm.
         """
         data = make_data_format(hypothesis, self.request_data_format)
 

beat/backend/python/execution/messagehandlers.py

@@ -348,8 +348,8 @@ class LoopMessageHandler(MessageHandler):
         """ Setup the loop internals
 
         Parameters:
-            algorithm (:py:class:`algorithm.Algorithm`) : algorithm for which
-            the communication channel is setup.
+            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")

conda/meta.yaml

@@ -23,7 +23,7 @@ build:
     # installs the documentation source, readme to share/doc so it is available
     # during test time
     - install -d "${PREFIX}/share/doc/{{ name }}"
-    - cp -R README.rst doc "${PREFIX}/share/doc/{{ name }}/"
+    - cp -R README.rst requirements.txt doc "${PREFIX}/share/doc/{{ name }}/"
 
 requirements:
   host:

doc/conf.py

 #!/usr/bin/env python
-# vim: set fileencoding=utf-8 :
+# -*- coding: utf-8 -*-
 
 import os
-import sys
-import glob
 import pkg_resources
 
-
 # -- General configuration -----------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
@@ -30,7 +27,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 = []
@@ -58,7 +55,7 @@ autosummary_generate = True
 numfig = True
 
 # If we are on OSX, the 'dvipng' path maybe different
-dvipng_osx = '/opt/local/libexec/texlive/binaries/dvipng'
+dvipng_osx = '/Library/TeX/texbin/dvipng'
 if os.path.exists(dvipng_osx): pngmath_dvipng = dvipng_osx
 
 # Add any paths that contain templates here, relative to this directory.
@@ -257,7 +254,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