Do not allow intersphinx mappings unless :external: role is used - add this role to rstcheck linting

benjaoming · benjaoming · commit 53e2850b28eb · 2022-06-14T12:39:50.000+02:00
diff --git a/docs/.rstcheck.cfg b/docs/.rstcheck.cfg
@@ -1,6 +1,6 @@
 [rstcheck]
 ignore_directives=automodule,http:get,tabs,tab,prompt,http:patch,http:post,http:put,http:delete
-ignore_roles=djangosetting,setting,featureflags,buildpyversions
+ignore_roles=djangosetting,setting,featureflags,buildpyversions,external+rtd:doc,external,external+rtd
 ignore_substitutions=org_brand,com_brand,:smile:,:arrows_counterclockwise:,:heavy_plus_sign:,:tada:,:heart:,:pencil2:
 # This error needs to be ignored for now
 # See: https://github.com/myint/rstcheck/issues/19
diff --git a/docs/conf.py b/docs/conf.py
@@ -94,6 +94,9 @@
     "rtd": ("https://docs.readthedocs.io/en/stable/", None),
     "rtd-dev": ("https://dev.readthedocs.io/en/latest/", None),
 }
+# Redundant in Sphinx 5.0
+# https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_disabled_reftypes
+intersphinx_disabled_reftypes = ["std:doc"]
 myst_enable_extensions = [
     "deflist",
 ]

Original file line number	Diff line number	Diff line change
`@@ -94,6 +94,9 @@`
`94`	`94`	`"rtd": ("https://docs.readthedocs.io/en/stable/", None),`
`95`	`95`	`"rtd-dev": ("https://dev.readthedocs.io/en/latest/", None),`
`96`	`96`	`}`
	`97`	`+# Redundant in Sphinx 5.0`
	`98`	`+# https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#confval-intersphinx_disabled_reftypes`
	`99`	`+intersphinx_disabled_reftypes = ["std:doc"]`
`97`	`100`	`myst_enable_extensions = [`
`98`	`101`	`"deflist",`
`99`	`102`	`]`