[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v3 2/2] docs/sphinx: change default role to "any"
From: |
John Snow |
Subject: |
[PATCH v3 2/2] docs/sphinx: change default role to "any" |
Date: |
Thu, 23 Sep 2021 15:13:23 -0400 |
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 <jsnow@redhat.com>
---
docs/conf.py | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/docs/conf.py b/docs/conf.py
index ff6e92c6e2e..4d9f56601fc 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'
--
2.31.1