[v5,4/4] docs/sphinx: change default role to "any"

Commit Message

John Snow Nov. 2, 2021, 6:44 p.m. UTC

This interprets single-backtick syntax in all of our Sphinx docs as a
cross-reference to *something*, including Python symbols.

From here on out, new uses of `backticks` will cause a build failure if
the target cannot be referenced.

Signed-off-by: John Snow <[e-mail]>
Reviewed-by: Eduardo Habkost <[e-mail]>
Reviewed-by: Peter Maydell <[e-mail]>
---
 docs/conf.py | 5 +++++
 1 file changed, 5 insertions(+)

Patch

diff --git a/docs/conf.py b/docs/conf.py
index ff6e92c6e2..4d9f56601f 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -85,6 +85,11 @@ 
 # The master toctree document.
 master_doc = 'index'
 
+# Interpret `single-backticks` to be a cross-reference to any kind of
+# referenceable object. Unresolvable or ambiguous references will emit a
+# warning at build time.
+default_role = 'any'
+
 # General information about the project.
 project = u'QEMU'
 copyright = u'2021, The QEMU Project Developers'