Merge branch 'nitpicky' into 'master'

[sphinx] Enable '-n' mode automatically; Allow user to ignore things



See merge request !7

templates/sphinx-conf.py

@@ -34,6 +34,25 @@ if sphinx.__version__ >= "1.4.1":
 else:
     extensions.append('sphinx.ext.pngmath')
 
+# Be picky about warnings
+nitpicky = True
+
+# Ignores stuff we can't easily resolve on other project's sphinx manuals
+nitpick_ignore = []
+
+# Allows the user to override warnings from a separate file
+if os.path.exists('nitpick-exceptions.txt'):
+    for line in open('nitpick-exceptions.txt'):
+          if line.strip() == "" or line.startswith("#"):
+                    continue
+    dtype, target = line.split(None, 1)
+    target = target.strip()
+    try: # python 2.x
+              target = unicode(target)
+    except NameError:
+              pass
+    nitpick_ignore.append((dtype, target))
+
 # Always includes todos
 todo_include_todos = True