| Message ID | 20210805004837.1775306-3-jsnow@redhat.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | docs/sphinx: change default `role` to "any" | expand |
On Wed, Aug 04, 2021 at 08:48:37PM -0400, John Snow wrote: > This interprets single-backtick syntax in all of our Sphinx docs as a > cross-reference to *something*, including Python symbols. If it doesn't > resolve, or resolves to too more than one thing, Sphinx will emit a s/too // > warning and the build will fail. > > 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 ff6e92c6e2e..acaf883704a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -85,6 +85,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'2021, The QEMU Project Developers'
This interprets single-backtick syntax in all of our Sphinx docs as a cross-reference to *something*, including Python symbols. If it doesn't resolve, or resolves to too more than one thing, Sphinx will emit a warning and the build will fail. Signed-off-by: John Snow <jsnow@redhat.com> --- docs/conf.py | 3 +++ 1 file changed, 3 insertions(+)