Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 0b35884

Browse files
committed
Fix missing-references.json.
I think what happened is that the way nested classes are referred to in inheritance diagrams has improved (the qualified name is more correct now), which caused missing-references.json to go out of sync. Unfortunately this means missing-references.json can either be compatible with sphinx<3.0 or with sphinx>3.0, but to be compatible with both we'd likely need to generate one with both versions and merge the two json files, which seems not worth it. Instead, just drop nitpicky mode for older sphixes (sphinges?).
1 parent d1f07d3 commit 0b35884

File tree

2 files changed

+91
-147
lines changed

2 files changed

+91
-147
lines changed

doc/conf.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,9 @@ def _check_dependencies():
102102
else:
103103
autodoc_default_options = {'members': None, 'undoc-members': None}
104104

105-
nitpicky = True
105+
# missing-references names matches sphinx>=3 behavior, so we can't be nitpicky
106+
# for older sphinxes.
107+
nitpicky = sphinx.version_info >= (3,)
106108
# change this to True to update the allowed failures
107109
missing_references_write_json = False
108110
missing_references_warn_unused_ignores = False

0 commit comments

Comments
 (0)