diff options
| author | John Snow <jsnow@redhat.com> | 2021-10-04 17:52:38 -0400 |
|---|---|---|
| committer | Marc-André Lureau <marcandre.lureau@redhat.com> | 2021-11-08 12:27:23 +0400 |
| commit | c11b3a1dd324d1f7dc8512bb840ffd8226fbd0a7 (patch) | |
| tree | d6262096025eab3b09fbd16e6c3588ed70fc5e83 /docs/conf.py | |
| parent | ca0a0d122c760a0763c68f348560bddfe482813c (diff) | |
docs/sphinx: change default role to "any"
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>
Diffstat (limited to 'docs/conf.py')
| -rw-r--r-- | docs/conf.py | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py index 3161b8b127..763e7d2434 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -85,6 +85,11 @@ source_suffix = '.rst' # 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' |