From 98c094227c7738a65dfc5908b3397d7275e56ea1 Mon Sep 17 00:00:00 2001
From: Ben Gamari <ben@smart-cactus.org>
Date: Sun, 6 Oct 2019 15:06:01 -0400
Subject: users-guide: Run sphinx in nit-picky mode

This ensure that it blurts an error on missing references.
---
 docs/users_guide/conf.py | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

(limited to 'docs/users_guide/conf.py')

diff --git a/docs/users_guide/conf.py b/docs/users_guide/conf.py
index 1f6f8b5b11..597d6765c7 100644
--- a/docs/users_guide/conf.py
+++ b/docs/users_guide/conf.py
@@ -24,6 +24,29 @@ source_suffix = '.rst'
 source_encoding = 'utf-8-sig'
 master_doc = 'index'
 
+nitpick_ignore = [
+    ("envvar", "EDITOR"),
+    ("envvar", "HOME"),
+    ("envvar", "LD_LIBRARY_PATH"),
+    ("envvar", "LIBRARY_PATH"),
+    ("envvar", "PATH"),
+    ("envvar", "RPATH"),
+    ("envvar", "RUNPATH"),
+    ("envvar", "TMPDIR"),
+
+    ("c:type", "bool"),
+
+    # See #17314
+    ("ghc-flag", "-pgmo ⟨port⟩"),
+    ("ghc-flag", "-pgmo ⟨option⟩"),
+
+    ("extension", "DoAndIfThenElse"),
+    ("extension", "RelaxedPolyRec"),
+
+    # See #16629
+    ("extension", "UnliftedFFITypes"),
+]
+
 rst_prolog = """
 .. |llvm-version| replace:: {llvm_version}
 """.format(llvm_version=ghc_config.llvm_version)
-- 
cgit v1.2.1