diff options
author | John Snow <jsnow@redhat.com> | 2021-10-04 17:52:36 -0400 |
---|---|---|
committer | Marc-André Lureau <marcandre.lureau@redhat.com> | 2021-11-08 12:27:23 +0400 |
commit | 450e0f28a476342baf1ed14a6c2a230e738f83bf (patch) | |
tree | e1fbb3cf53a912b17c616329fa82a25bdc6d2c31 /VERSION | |
parent | 9423751645d27ae1146ca645431c368f09cb3b6c (diff) | |
download | qemu-450e0f28a476342baf1ed14a6c2a230e738f83bf.zip qemu-450e0f28a476342baf1ed14a6c2a230e738f83bf.tar.gz qemu-450e0f28a476342baf1ed14a6c2a230e738f83bf.tar.bz2 |
docs: remove non-reference uses of single backticks
The single backtick markup in ReST is the "default role". Currently,
Sphinx's default role is called "content". Sphinx suggests you can use
the "Any" role instead to turn any single-backtick enclosed item into a
cross-reference.
This is useful for things like autodoc for Python docstrings, where it's
often nicer to reference other types with `foo` instead of the more
laborious :py:meth:`foo`. It's also useful in multi-domain cases to
easily reference definitions from other Sphinx domains, such as
referencing C code definitions from outside of kerneldoc comments.
Before we do that, though, we'll need to turn all existing usages of the
"content" role to inline verbatim markup wherever it does not correctly
resolve into a cross-refernece by using double backticks instead.
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Eduardo Habkost <ehabkost@redhat.com>
Reviewed-by: Alexander Bulekov <alxndr@bu.edu>
Message-Id: <20211004215238.1523082-2-jsnow@redhat.com>
Diffstat (limited to 'VERSION')
0 files changed, 0 insertions, 0 deletions