aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPeter Maydell <peter.maydell@linaro.org>2019-03-07 14:26:46 +0000
committerPeter Maydell <peter.maydell@linaro.org>2019-03-07 14:26:46 +0000
commite250e867dc0172203b30aa25032efe29f1102b21 (patch)
tree420ab3407e6990429923204e272907614f2687df /docs
parent479fb8a5114cc87fdf96bb21e4cf0b5798286444 (diff)
docs/conf.py: Disable option warnings
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
Diffstat (limited to 'docs')
-rw-r--r--docs/conf.py3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/conf.py b/docs/conf.py
index d3018bc539..56a74e0fcb 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 ----------------------------------------------