diff --git a/templates/sphinx-conf.py b/templates/sphinx-conf.py index ff69d7ec0a6bafcbd12b58c612854a2f28d3ddd2..3bc6befed063ecc62bdf96991d9e686c9472472e 100644 --- a/templates/sphinx-conf.py +++ b/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