enable nitpicky warnings for docs builds

This commit is contained in:
nulano 2020-07-10 01:48:42 +02:00
parent f2c4be799c
commit 6db12b29d9

View File

@ -103,6 +103,17 @@ pygments_style = "sphinx"
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
# If true, Sphinx will warn about all references where the target cannot be found.
# Default is False. You can activate this mode temporarily using the -n command-line
# switch.
nitpicky = True
# A list of (type, target) tuples (by default empty) that should be ignored when
# generating warnings in “nitpicky mode”. Note that type should include the domain name
# if present. Example entries would be ('py:func', 'int') or
# ('envvar', 'LD_LIBRARY_PATH').
# nitpick_ignore = []
# -- Options for HTML output ----------------------------------------------