| Message ID | 20190305172139.32662-8-peter.maydell@linaro.org (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
| Series | Enable build and install of our rST docs | expand |
On 3/5/19 9:21 AM, Peter Maydell wrote: > 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> > Message-id: 20190228145624.24885-8-peter.maydell@linaro.org > --- > docs/conf.py | 3 +++ > 1 file changed, 3 insertions(+) Reviewed-by: Richard Henderson <richard.henderson@linaro.org> r~
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 ----------------------------------------------