Skip to content

Commit b5e7972

Browse files
Doc: enable nitpicky
1 parent f40e4cf commit b5e7972

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

docs/source/conf.py

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,24 @@
6767
with open("_static/links.rst", encoding="utf-8") as f:
6868
rst_epilog += f.read()
6969

70+
############ Options for nitpicky mode ############
71+
72+
# In nitpicky mode, Sphinx will warn about all references where the target
73+
# cannot be found.
74+
nitpicky = True
75+
76+
# A set or list of (warning_type, target) tuples that should be ignored when
77+
# generating warnings in "nitpicky mode".
78+
# See https://github.com/sphinx-doc/sphinx/issues/10785 for why the numpy ones
79+
# don't work.
80+
nitpick_ignore = {
81+
("py:class", "Element"),
82+
("py:class", "Letter"),
83+
("py:class", "Point"),
84+
("py:class", "Range"),
85+
("py:class", "Word"),
86+
("py:class", "numpy.float64"),
87+
}
7088

7189
############ Options for source files ############
7290

0 commit comments

Comments
 (0)