Skip to content

Commit d1c962f

Browse files
committed
doc: enable nitpicky mode
Ensures all references resolve.
1 parent 5694179 commit d1c962f

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

doc/conf.py

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,11 @@
2626
# Add any Sphinx extension module names here, as strings.
2727
# They can be extensions
2828
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
29-
extensions = ["sphinx.ext.autodoc", "sphinx.ext.doctest"]
29+
extensions = [
30+
"sphinx.ext.autodoc",
31+
"sphinx.ext.doctest",
32+
"sphinx.ext.intersphinx",
33+
]
3034

3135
# Add any paths that contain templates here, relative to this directory.
3236
templates_path = ["_templates"]
@@ -83,6 +87,16 @@
8387
# A list of ignored prefixes for module index sorting.
8488
# modindex_common_prefix = []
8589

90+
intersphinx_mapping = {
91+
"python": ("https://docs.python.org/3", None),
92+
}
93+
94+
nitpicky = True
95+
nitpick_ignore = [
96+
("py:class", "execnet.gateway_base.ChannelFileRead"),
97+
("py:class", "execnet.gateway_base.ChannelFileWrite"),
98+
("py:class", "execnet.gateway.Gateway"),
99+
]
86100

87101
# -- Options for HTML output --------------------------------------------------
88102

0 commit comments

Comments
 (0)