[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Qemu-devel] [PATCH 07/11] docs/conf.py: Disable option warnings
From: |
Alex Bennée |
Subject: |
Re: [Qemu-devel] [PATCH 07/11] docs/conf.py: Disable option warnings |
Date: |
Fri, 01 Feb 2019 16:44:18 +0000 |
User-agent: |
mu4e 1.0; emacs 26.1 |
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
- Re: [Qemu-devel] [PATCH 01/11] docs/cpu-hotplug.rst: Fix rST markup issues, (continued)
- [Qemu-devel] [PATCH 04/11] docs/conf.py: Disable unused _static directory, Peter Maydell, 2019/02/01
- [Qemu-devel] [PATCH 03/11] docs: Commit initial files from sphinx-quickstart, Peter Maydell, 2019/02/01
- [Qemu-devel] [PATCH 06/11] docs/conf.py: Don't include rST sources in HTML build, Peter Maydell, 2019/02/01
- [Qemu-devel] [PATCH 07/11] docs/conf.py: Disable option warnings, Peter Maydell, 2019/02/01
- Re: [Qemu-devel] [PATCH 07/11] docs/conf.py: Disable option warnings,
Alex Bennée <=
- [Qemu-devel] [PATCH 05/11] docs/conf.py: Configure the 'alabaster' theme, Peter Maydell, 2019/02/01
- [Qemu-devel] [PATCH 02/11] docs: Convert memory.txt to rst format, Peter Maydell, 2019/02/01
- [Qemu-devel] [PATCH 08/11] Separate conf.py for each manual we want, Peter Maydell, 2019/02/01
- [Qemu-devel] [PATCH 11/11] docs/conf.py: Don't hard-code QEMU version, Peter Maydell, 2019/02/01
- [Qemu-devel] [PATCH 09/11] Makefile, configure: Support building rST documentation, Peter Maydell, 2019/02/01