[PATCH v2 2/4] [DO-NOT-MERGE] docs/sphinx: change default role to "any"

John Snow posted 4 patches 4 years, 9 months ago
Maintainers: Paolo Bonzini <pbonzini@redhat.com>, Bandan Das <bsd@redhat.com>, Laurent Vivier <lvivier@redhat.com>, "Alex Bennée" <alex.bennee@linaro.org>, Michael Roth <michael.roth@amd.com>, "Dr. David Alan Gilbert" <dgilbert@redhat.com>, Thomas Huth <thuth@redhat.com>, Radoslaw Biernacki <rad@semihalf.com>, Tyrone Ting <kfting@nuvoton.com>, Eric Blake <eblake@redhat.com>, Havard Skinnemoen <hskinnemoen@google.com>, Stefan Hajnoczi <stefanha@redhat.com>, Juan Quintela <quintela@redhat.com>, Markus Armbruster <armbru@redhat.com>, Leif Lindholm <leif@nuviainc.com>, Cornelia Huck <cohuck@redhat.com>, Alexander Bulekov <alxndr@bu.edu>, Peter Maydell <peter.maydell@linaro.org>
There is a newer version of this series
[PATCH v2 2/4] [DO-NOT-MERGE] docs/sphinx: change default role to "any"
Posted by John Snow 4 years, 9 months ago
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 2ee61118725..8752e436ebe 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.30.2