Enable nitpicky mode

alexrudy · alexrudy · commit 9e0ffe1d60c8 · 2019-07-30T23:13:11.000-07:00
diff --git a/doc/conf.py b/doc/conf.py
@@ -100,6 +100,8 @@ def _check_dependencies():
 else:
     autodoc_default_options = {'members': None, 'undoc-members': None}
 
+nitpicky = True
+
 intersphinx_mapping = {
     'python': ('https://docs.python.org/3', None),
     'numpy': ('https://docs.scipy.org/doc/numpy/', None),
diff --git a/doc/sphinxext/missing_references.py b/doc/sphinxext/missing_references.py
@@ -5,10 +5,10 @@
 The basic operation is:
 
 1. Add this extension to your ``conf.py`` extensions.
-2. Add ``missing_references_freeze = True`` to your ``conf.py``
+2. Add ``missing_references_write_json = True`` to your ``conf.py``
 3. Run sphinx-build. It will generate ``missing-references.json``
     next to your ``conf.py``.
-4. Remove ``missing_references_freeze = True`` from your
+4. Remove ``missing_references_write_json = True`` from your
     ``conf.py`` (or set it to ``False``)
 5. Run sphinx-build again, and ``nitpick_ignore`` will
     contain all of the previously failed references.
@@ -20,7 +20,7 @@
 
 
 def record_missing_reference_handler(app, env, node, contnode):
-    if not app.config.missing_references_freeze:
+    if not app.config.missing_references_write_json:
         # no-op when we are disabled.
         return
 
@@ -38,7 +38,7 @@ def record_missing_reference_handler(app, env, node, contnode):
 
 
 def save_missing_references_handler(app, exc):
-    if not app.config.missing_references_freeze:
+    if not app.config.missing_references_write_json:
         # no-op when we are disabled.
         return
 
@@ -48,7 +48,7 @@ def save_missing_references_handler(app, exc):
 
 
 def prepare_missing_references_handler(app, config):
-    if config.missing_references_freeze:
+    if config.missing_references_write_json:
         return
 
     path = os.path.join(app.confdir, "missing-references.json")
@@ -62,7 +62,7 @@ def prepare_missing_references_handler(app, config):
 
 
 def setup(app):
-    app.add_config_value("missing_references_freeze", False, "env")
+    app.add_config_value("missing_references_write_json", False, "env")
 
     app.connect("config-inited", prepare_missing_references_handler)
     app.connect("missing-reference", record_missing_reference_handler)
