Turn on nitpicky mode for documentation builds (#429)

enthought · Jul 17, 2021 · 6bd09ef · 6bd09ef
1 parent bb1ff5c
commit 6bd09ef
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 6 deletions.
diff --git a/ci/__main__.py b/ci/__main__.py
@@ -226,12 +226,7 @@ def doc(edm, python_version, toolkit):
     """
     pyenv = _get_devenv(edm, python_version, toolkit)
 
-    # Be nitpicky. This detects missing class references.
-    sphinx_options = ["-n"]
-
-    build_cmd = ["-m", "sphinx"]
-    build_cmd.extend(sphinx_options)
-    build_cmd.extend([cfg.DOCS_SOURCE_DIR, cfg.DOCS_BUILD_DIR])
+    build_cmd = ["-m", "sphinx", cfg.DOCS_SOURCE_DIR, cfg.DOCS_BUILD_DIR]
     pyenv.python(build_cmd)
 
 

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -98,6 +98,9 @@
 # Don't include parentheses after function and method names.
 add_function_parentheses = False
 
+# Do use nitpicky mode: we want to know about broken references.
+nitpicky = True
+
 # Ignore complaints about references to classes in wx and pyface.qt.QtCore
 nitpick_ignore = [
     # Exclusions needed for Sphinx < 4.