]> git.proxmox.com Git - mirror_qemu.git/commitdiff
docs/conf.py: Disable option warnings
authorPeter Maydell <peter.maydell@linaro.org>
Thu, 7 Mar 2019 14:26:46 +0000 (14:26 +0000)
committerPeter Maydell <peter.maydell@linaro.org>
Thu, 7 Mar 2019 14:26:46 +0000 (14:26 +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 <peter.maydell@linaro.org>
Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
Acked-by: Aleksandar Markovic <amarkovic@wavecomp.com>
Reviewed-by: Richard Henderson <richard.henderson@linaro.org>
Message-id: 20190305172139.32662-8-peter.maydell@linaro.org
Message-id: 20190228145624.24885-8-peter.maydell@linaro.org

docs/conf.py

index d3018bc5395d6e1ed7e3eee60e9f4b177a9bd850..56a74e0fcb3420fdd87d153350f7816bfaa898d9 100644 (file)
@@ -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 ----------------------------------------------