Re: [Qemu-devel] [PATCH 07/11] docs/conf.py: Disable option warnings

[Alex Bennée]

Peter Maydell <address@hidden> writes:

> 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>

> ---
>  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 ----------------------------------------------


--
Alex Bennée