From: John Snow <jsnow@redhat.com> To: qemu-devel@nongnu.org Cc: "Peter Maydell" <peter.maydell@linaro.org>, "Stefan Hajnoczi" <stefanha@redhat.com>, "Alex Bennée" <alex.bennee@linaro.org>, "Darren Kenny" <darren.kenny@oracle.com>, "Daniel P. Berrangé" <berrange@redhat.com>, "Marcelo Tosatti" <mtosatti@redhat.com>, "Eduardo Habkost" <ehabkost@redhat.com>, "Qiuhao Li" <Qiuhao.Li@outlook.com>, "Paolo Bonzini" <pbonzini@redhat.com>, "Eric Blake" <eblake@redhat.com>, "Alexandre Iooss" <erdnaxe@crans.org>, "Mahmoud Mandour" <ma.mandourr@gmail.com>, "Alexander Bulekov" <alxndr@bu.edu>, "Markus Armbruster" <armbru@redhat.com>, kvm@vger.kernel.org, "Thomas Huth" <thuth@redhat.com>, "Bandan Das" <bsd@redhat.com>, "John Snow" <jsnow@redhat.com> Subject: [PATCH v5 4/4] docs/sphinx: change default role to "any" Date: Tue, 2 Nov 2021 14:44:00 -0400 [thread overview] Message-ID: <20211102184400.1168508-5-jsnow@redhat.com> (raw) In-Reply-To: <20211102184400.1168508-1-jsnow@redhat.com> 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> --- docs/conf.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index ff6e92c6e2..4d9f56601f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -85,6 +85,11 @@ # 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' -- 2.31.1
WARNING: multiple messages have this Message-ID (diff)
From: John Snow <jsnow@redhat.com> To: qemu-devel@nongnu.org Cc: "Peter Maydell" <peter.maydell@linaro.org>, "Thomas Huth" <thuth@redhat.com>, "Daniel P. Berrangé" <berrange@redhat.com>, "Eduardo Habkost" <ehabkost@redhat.com>, kvm@vger.kernel.org, "Alexander Bulekov" <alxndr@bu.edu>, "Eric Blake" <eblake@redhat.com>, "Marcelo Tosatti" <mtosatti@redhat.com>, "Qiuhao Li" <Qiuhao.Li@outlook.com>, "Markus Armbruster" <armbru@redhat.com>, "John Snow" <jsnow@redhat.com>, "Darren Kenny" <darren.kenny@oracle.com>, "Bandan Das" <bsd@redhat.com>, "Stefan Hajnoczi" <stefanha@redhat.com>, "Alexandre Iooss" <erdnaxe@crans.org>, "Paolo Bonzini" <pbonzini@redhat.com>, "Mahmoud Mandour" <ma.mandourr@gmail.com>, "Alex Bennée" <alex.bennee@linaro.org> Subject: [PATCH v5 4/4] docs/sphinx: change default role to "any" Date: Tue, 2 Nov 2021 14:44:00 -0400 [thread overview] Message-ID: <20211102184400.1168508-5-jsnow@redhat.com> (raw) In-Reply-To: <20211102184400.1168508-1-jsnow@redhat.com> 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> --- docs/conf.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index ff6e92c6e2..4d9f56601f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -85,6 +85,11 @@ # 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' -- 2.31.1
next prev parent reply other threads:[~2021-11-02 18:47 UTC|newest] Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top 2021-11-02 18:43 [PATCH v5 0/4] docs/sphinx: change default `role` to "any" John Snow 2021-11-02 18:43 ` John Snow 2021-11-02 18:43 ` [PATCH v5 1/4] docs: remove non-reference uses of single backticks John Snow 2021-11-02 18:43 ` John Snow 2021-11-02 18:43 ` [PATCH v5 2/4] docs: (further) " John Snow 2021-11-02 18:43 ` John Snow 2021-11-03 6:40 ` Thomas Huth 2021-11-03 6:40 ` Thomas Huth 2021-11-02 18:43 ` [PATCH v5 3/4] docs: (further further) " John Snow 2021-11-02 18:43 ` John Snow 2021-11-03 6:41 ` Thomas Huth 2021-11-03 6:41 ` Thomas Huth 2021-11-02 18:44 ` John Snow [this message] 2021-11-02 18:44 ` [PATCH v5 4/4] docs/sphinx: change default role to "any" 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=20211102184400.1168508-5-jsnow@redhat.com \ --to=jsnow@redhat.com \ --cc=Qiuhao.Li@outlook.com \ --cc=alex.bennee@linaro.org \ --cc=alxndr@bu.edu \ --cc=armbru@redhat.com \ --cc=berrange@redhat.com \ --cc=bsd@redhat.com \ --cc=darren.kenny@oracle.com \ --cc=eblake@redhat.com \ --cc=ehabkost@redhat.com \ --cc=erdnaxe@crans.org \ --cc=kvm@vger.kernel.org \ --cc=ma.mandourr@gmail.com \ --cc=mtosatti@redhat.com \ --cc=pbonzini@redhat.com \ --cc=peter.maydell@linaro.org \ --cc=qemu-devel@nongnu.org \ --cc=stefanha@redhat.com \ --cc=thuth@redhat.com \ /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: linkBe sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes, see mirroring instructions on how to clone and mirror all data and code used by this external index.