[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PATCH v3 07/12] docs/conf.py: Disable option warnings
From: |
Peter Maydell |
Subject: |
[Qemu-devel] [PATCH v3 07/12] docs/conf.py: Disable option warnings |
Date: |
Tue, 5 Mar 2019 17:21:34 +0000 |
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 <address@hidden>
Reviewed-by: Alex Bennée <address@hidden>
Acked-by: Aleksandar Markovic <address@hidden>
Message-id: address@hidden
---
docs/conf.py | 3 +++
1 file changed, 3 insertions(+)
diff --git a/docs/conf.py b/docs/conf.py
index d3018bc5395..56a74e0fcb3 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -77,6 +77,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
- [Qemu-devel] [PATCH v3 02/12] docs: Convert memory.txt to rst format, (continued)
- [Qemu-devel] [PATCH v3 02/12] docs: Convert memory.txt to rst format, Peter Maydell, 2019/03/05
- [Qemu-devel] [PATCH v3 05/12] docs/conf.py: Configure the 'alabaster' theme, Peter Maydell, 2019/03/05
- [Qemu-devel] [PATCH v3 04/12] docs/conf.py: Disable unused _static directory, Peter Maydell, 2019/03/05
- [Qemu-devel] [PATCH v3 03/12] docs: Commit initial files from sphinx-quickstart, Peter Maydell, 2019/03/05
- [Qemu-devel] [PATCH v3 06/12] docs/conf.py: Don't include rST sources in HTML build, Peter Maydell, 2019/03/05
- [Qemu-devel] [PATCH v3 07/12] docs/conf.py: Disable option warnings,
Peter Maydell <=
- [Qemu-devel] [PATCH v3 10/12] Makefile: Abstract out "identify the pkgversion" code, Peter Maydell, 2019/03/05
- [Qemu-devel] [PATCH v3 09/12] Makefile, configure: Support building rST documentation, Peter Maydell, 2019/03/05
- [Qemu-devel] [PATCH v3 08/12] docs: Provide separate conf.py for each manual we want, Peter Maydell, 2019/03/05