[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [RFC 04/10] docs/conf.py: Ignore some missing references in
From: |
Peter Maydell |
Subject: |
[Qemu-devel] [RFC 04/10] docs/conf.py: Ignore some missing references in nitpick mode |
Date: |
Tue, 21 May 2019 13:25:13 +0100 |
We enable Sphinx's 'nitpick' mode via the command line -n switch, which
means it warns about references to things it doesn't know about. Add
a whitelist of expected-not-to-be-present types, to avoid false
positives when C function prototypes use standard integer types.
If this whitelist gets too long and unmanageable we might be better
off switching to non-nitpick mode instead.
Signed-off-by: Peter Maydell <address@hidden>
---
docs/conf.py | 11 +++++++++++
1 file changed, 11 insertions(+)
diff --git a/docs/conf.py b/docs/conf.py
index 9109edbcb97..388299fb25b 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -114,6 +114,17 @@ todo_include_todos = False
# with "option::" in the document being processed. Turn that off.
suppress_warnings = ["ref.option"]
+nitpick_ignore = [
+ ("c:type", "int8_t"),
+ ("c:type", "int16_t"),
+ ("c:type", "int32_t"),
+ ("c:type", "int64_t"),
+ ("c:type", "uint8_t"),
+ ("c:type", "uint16_t"),
+ ("c:type", "uint32_t"),
+ ("c:type", "uint64_t"),
+]
+
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
--
2.20.1
- [Qemu-devel] [RFC 00/10] Add kernel-doc support to our Sphinx setup, Peter Maydell, 2019/05/21
- [Qemu-devel] [RFC 03/10] docs/conf.py: Enable use of kerneldoc sphinx extension, Peter Maydell, 2019/05/21
- [Qemu-devel] [RFC 04/10] docs/conf.py: Ignore some missing references in nitpick mode,
Peter Maydell <=
- [Qemu-devel] [RFC 05/10] bitops.h: Silence kernel-doc complaints, Peter Maydell, 2019/05/21
- [Qemu-devel] [RFC 02/10] docs: Add kerneldoc sphinx module from Linux, Peter Maydell, 2019/05/21
- [Qemu-devel] [RFC 10/10] Makefile: disable Sphinx nitpicking, Peter Maydell, 2019/05/21
- [Qemu-devel] [RFC 07/10] memory.h: Fix kerneldoc syntax issues, Peter Maydell, 2019/05/21
- [Qemu-devel] [RFC 08/10] docs: Add kernel-doc API documentation to memory.rst, Peter Maydell, 2019/05/21
- [Qemu-devel] [RFC 09/10] memory.h: attempted kernel-doc fixes, Peter Maydell, 2019/05/21
- [Qemu-devel] [RFC 06/10] docs: Create bitops.rst as example of kernel-docs, Peter Maydell, 2019/05/21
- [Qemu-devel] [RFC 01/10] scripts/kernel-doc: Import kernel-doc script from Linux, Peter Maydell, 2019/05/21
- Re: [Qemu-devel] [RFC 00/10] Add kernel-doc support to our Sphinx setup, Peter Maydell, 2019/05/21
- Re: [Qemu-devel] [RFC 00/10] Add kernel-doc support to our Sphinx setup, no-reply, 2019/05/21