enable nitpicky

Lightning-AI · Sep 20, 2023 · 4ce0195 · 4ce0195
1 parent 3a59462
commit 4ce0195
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/docs/source-app/conf.py b/docs/source-app/conf.py
@@ -254,6 +254,16 @@
     # "numpy": ("https://docs.scipy.org/doc/numpy/", None),
 }
 
+nitpicky = True
+
+
+nitpick_ignore = [
+    ("py:class", "typing.Self"),
+    # missing in generated API
+    ("py:exc", "MisconfigurationException"),
+    # TODO: generated list of all existing ATM, need to be fixed
+]
+
 # -- Options for todo extension ----------------------------------------------
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.