From: John Snow <jsnow@redhat.com>
To: qemu-devel@nongnu.org
Cc: "Marc-André Lureau" <marcandre.lureau@redhat.com>,
"John Snow" <jsnow@redhat.com>,
"Markus Armbruster" <armbru@redhat.com>,
"Eduardo Habkost" <ehabkost@redhat.com>,
"Cleber Rosa" <crosa@redhat.com>
Subject: [PATCH 2/3] [DO-NOT-MERGE] docs/sphinx: change default role to "any"
Date: Mon, 14 Dec 2020 18:41:44 -0500 [thread overview]
Message-ID: <20201214234145.1005829-3-jsnow@redhat.com> (raw)
In-Reply-To: <20201214234145.1005829-1-jsnow@redhat.com>
This interprets single-backtick syntax in all of our Sphinx docs as a
cross-reference to *something*, including Python symbols.
Signed-off-by: John Snow <jsnow@redhat.com>
---
docs/conf.py | 3 +++
1 file changed, 3 insertions(+)
diff --git a/docs/conf.py b/docs/conf.py
index d40d8ff37bab..d0a8f78f6ead 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -84,6 +84,9 @@
# The master toctree document.
master_doc = 'index'
+# Interpret `this` to be a cross-reference to "anything".
+default_role = 'any'
+
# General information about the project.
project = u'QEMU'
copyright = u'2020, The QEMU Project Developers'
--
2.26.2
next prev parent reply other threads:[~2020-12-14 23:45 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-12-14 23:41 [PATCH 0/3] qapi: sphinx-autodoc for qapi module John Snow
2020-12-14 23:41 ` [PATCH 1/3] [DO-NOT-MERGE] docs: replace single backtick (`) with double-backtick (``) John Snow
2020-12-14 23:41 ` John Snow [this message]
2020-12-14 23:41 ` [PATCH 3/3] [DO-NOT-MERGE] docs: enable sphinx-autodoc for scripts/qapi John Snow
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20201214234145.1005829-3-jsnow@redhat.com \
--to=jsnow@redhat.com \
--cc=armbru@redhat.com \
--cc=crosa@redhat.com \
--cc=ehabkost@redhat.com \
--cc=marcandre.lureau@redhat.com \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).