Make Sphinx build nitpicky

Author: webknjaz

noxfile.py

@@ -30,6 +30,7 @@ def build(session, autobuild=False):
         # Ref: https://github.com/pypa/pypa-docs-theme/issues/17
         # "-j", "auto",  # parallelize the build
         "-b", "html",  # use HTML builder
+        "-n",  # nitpicky warn about all missing references
         "-W",  # Treat warnings as errors.
         "source",  # where the rst files are located
         target_build_dir,  # where to put the html output

source/conf.py

@@ -382,3 +382,17 @@
 # The default is False.
 
 todo_include_todos = True
+
+nitpicky = True
+
+# NOTE: consider having a separate ignore file
+# Ref: https://stackoverflow.com/a/30624034/595220
+nitpick_ignore = [
+    ('envvar', 'PATH'),
+    ('py:func', 'find_packages'),
+    ('py:func', 'pkg_resources.iter_entry_points'),
+    ('py:func', 'setup'),
+    ('py:func', 'setuptools.find_namespace_packages'),
+    ('py:func', 'setuptools.find_packages'),
+    ('py:func', 'setuptools.setup'),
+]