From: Peter Maydell <peter.maydell@linaro.org>
To: qemu-devel@nongnu.org
Cc: patches@linaro.org, "Alex Bennée" <alex.bennee@linaro.org>,
"Paolo Bonzini" <pbonzini@redhat.com>,
"Marc-André Lureau" <marcandre.lureau@redhat.com>,
"Stefan Hajnoczi" <stefanha@redhat.com>,
"Daniel P . Berrangé" <berrange@redhat.com>,
"Philippe Mathieu-Daudé" <philmd@redhat.com>
Subject: [Qemu-devel] [PATCH v2 07/11] docs/conf.py: Disable option warnings
Date: Thu, 28 Feb 2019 14:56:20 +0000 [thread overview]
Message-ID: <20190228145624.24885-8-peter.maydell@linaro.org> (raw)
In-Reply-To: <20190228145624.24885-1-peter.maydell@linaro.org>
sphinx-build complains about using :option: to mark up option
flags that it doesn't know about (because they were not defined
using the "option::" directive):
docs/pr-manager.rst:68: WARNING: unknown option: -d
Suppress these warnings. This way we get the semantic markup
of the option flag but no cross-referencing hyperlink.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
---
docs/conf.py | 3 +++
1 file changed, 3 insertions(+)
diff --git a/docs/conf.py b/docs/conf.py
index 6ddaa549f28..c04000e78e4 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -76,6 +76,9 @@ pygments_style = 'sphinx'
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
+# Sphinx defaults to warning about use of :option: for options not defined
+# with "option::" in the document being processed. Turn that off.
+suppress_warnings = ["ref.option"]
# -- Options for HTML output ----------------------------------------------
--
2.20.1
next prev parent reply other threads:[~2019-02-28 14:57 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-02-28 14:56 [Qemu-devel] [PATCH v2 00/11] Enable build and install of our rST docs Peter Maydell
2019-02-28 14:56 ` [Qemu-devel] [PATCH v2 01/11] docs/cpu-hotplug.rst: Fix rST markup issues Peter Maydell
2019-02-28 16:14 ` Philippe Mathieu-Daudé
2019-02-28 16:34 ` Peter Maydell
2019-02-28 14:56 ` [Qemu-devel] [PATCH v2 02/11] docs: Convert memory.txt to rst format Peter Maydell
2019-02-28 14:56 ` [Qemu-devel] [PATCH v2 03/11] docs: Commit initial files from sphinx-quickstart Peter Maydell
2019-02-28 16:01 ` Philippe Mathieu-Daudé
2019-02-28 16:27 ` Peter Maydell
2019-02-28 14:56 ` [Qemu-devel] [PATCH v2 04/11] docs/conf.py: Disable unused _static directory Peter Maydell
2019-02-28 14:56 ` [Qemu-devel] [PATCH v2 05/11] docs/conf.py: Configure the 'alabaster' theme Peter Maydell
2019-02-28 14:56 ` [Qemu-devel] [PATCH v2 06/11] docs/conf.py: Don't include rST sources in HTML build Peter Maydell
2019-02-28 14:56 ` Peter Maydell [this message]
2019-02-28 14:56 ` [Qemu-devel] [PATCH v2 08/11] docs: Provide separate conf.py for each manual we want Peter Maydell
2019-02-28 14:56 ` [Qemu-devel] [PATCH v2 09/11] Makefile, configure: Support building rST documentation Peter Maydell
2019-02-28 15:49 ` Philippe Mathieu-Daudé
2019-02-28 16:25 ` Peter Maydell
2019-03-05 12:47 ` Peter Maydell
2019-03-05 15:24 ` Peter Maydell
2019-03-06 10:53 ` Paolo Bonzini
2019-02-28 14:56 ` [Qemu-devel] [PATCH v2 10/11] Makefile: Abstract out "identify the pkgversion" code Peter Maydell
2019-02-28 14:56 ` [Qemu-devel] [PATCH v2 11/11] docs/conf.py: Don't hard-code QEMU version Peter Maydell
2019-02-28 15:55 ` Philippe Mathieu-Daudé
2019-02-28 15:15 ` [Qemu-devel] [PATCH v2 00/11] Enable build and install of our rST docs no-reply
2019-02-28 15:34 ` no-reply
2019-02-28 15:50 ` Aleksandar Markovic
2019-02-28 15:53 ` no-reply
2019-02-28 15:59 ` no-reply
2019-02-28 16:18 ` no-reply
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=20190228145624.24885-8-peter.maydell@linaro.org \
--to=peter.maydell@linaro.org \
--cc=alex.bennee@linaro.org \
--cc=berrange@redhat.com \
--cc=marcandre.lureau@redhat.com \
--cc=patches@linaro.org \
--cc=pbonzini@redhat.com \
--cc=philmd@redhat.com \
--cc=qemu-devel@nongnu.org \
--cc=stefanha@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: 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).