[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL v2 11/11] docs/sphinx: change default role to "any"
From: |
marcandre . lureau |
Subject: |
[PULL v2 11/11] docs/sphinx: change default role to "any" |
Date: |
Mon, 8 Nov 2021 13:01:55 +0400 |
From: John Snow <jsnow@redhat.com>
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>
Reviewed-by: Eduardo Habkost <ehabkost@redhat.com>
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Message-Id: <20211004215238.1523082-4-jsnow@redhat.com>
---
docs/conf.py | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/docs/conf.py b/docs/conf.py
index 3161b8b127c6..763e7d243448 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.33.0.721.g106298f7f9
- [PULL v2 00/11] Sphinx patches, marcandre . lureau, 2021/11/08
- [PULL v2 01/11] docs/sphinx: add loaded modules to generated depfile, marcandre . lureau, 2021/11/08
- [PULL v2 02/11] docs/sphinx: add static files to generated depfile, marcandre . lureau, 2021/11/08
- [PULL v2 03/11] docs/sphinx: add templates files to generated depfile, marcandre . lureau, 2021/11/08
- [PULL v2 04/11] tests/qapi-schema/meson: add depfile to sphinx doc, marcandre . lureau, 2021/11/08
- [PULL v2 05/11] meson: drop sphinx_extn_depends, marcandre . lureau, 2021/11/08
- [PULL v2 06/11] meson: drop sphinx_template_files, marcandre . lureau, 2021/11/08
- [PULL v2 07/11] docs/sphinx: set navigation_with_keys=True, marcandre . lureau, 2021/11/08
- [PULL v2 09/11] docs: remove non-reference uses of single backticks, marcandre . lureau, 2021/11/08
- [PULL v2 10/11] docs: (further) remove non-reference uses of single backticks, marcandre . lureau, 2021/11/08
- [PULL v2 11/11] docs/sphinx: change default role to "any",
marcandre . lureau <=
- [PULL v2 08/11] docs/sphinx: add 's' keyboard binding to focus search, marcandre . lureau, 2021/11/08
- Re: [PULL v2 00/11] Sphinx patches, Richard Henderson, 2021/11/08