[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 3/6] docs: disable sphinx warning about missing cross references
From: |
Paolo Bonzini |
Subject: |
[PATCH 3/6] docs: disable sphinx warning about missing cross references |
Date: |
Tue, 29 Oct 2019 17:22:45 +0100 |
Sphinx is a bit *too* strict about missing cross references to
C types, where it complains about missing references to uint8_t.
Even if that were fixed in kernel-doc, we would still have lots
of missing references to types that are not yet documented. So
unfortunately let's disable for now the nitpicking mode.
Signed-off-by: Paolo Bonzini <address@hidden> # still not a good idea, probably
---
Makefile | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/Makefile b/Makefile
index d20e7ffce3..8aa915ff26 100644
--- a/Makefile
+++ b/Makefile
@@ -986,7 +986,7 @@ sphinxdocs: $(MANUAL_BUILDDIR)/devel/index.html
$(MANUAL_BUILDDIR)/interop/index
# Note the use of different doctree for each (manual, builder) tuple;
# this works around Sphinx not handling parallel invocation on
# a single doctree: https://github.com/sphinx-doc/sphinx/issues/2946
-build-manual = $(call quiet-command,CONFDIR="$(qemu_confdir)" sphinx-build
$(if $(V),,-q) -W -n -b $2 -D version=$(VERSION) -D release="$(FULL_VERSION)"
-d .doctrees/$1-$2 $(SRC_PATH)/docs/$1 $(MANUAL_BUILDDIR)/$1
,"SPHINX","$(MANUAL_BUILDDIR)/$1")
+build-manual = $(call quiet-command,CONFDIR="$(qemu_confdir)" sphinx-build
$(if $(V),,-q) -W -b $2 -D version=$(VERSION) -D release="$(FULL_VERSION)" -d
.doctrees/$1-$2 $(SRC_PATH)/docs/$1 $(MANUAL_BUILDDIR)/$1
,"SPHINX","$(MANUAL_BUILDDIR)/$1")
# We assume all RST files in the manual's directory are used in it
manual-deps = $(wildcard $(SRC_PATH)/docs/$1/*.rst)
$(SRC_PATH)/docs/$1/conf.py $(SRC_PATH)/docs/conf.py
--
2.21.0
- [RFC PATCH 0/6] docs: integrate doc comments with Sphinx build, Paolo Bonzini, 2019/10/29
- [PATCH 2/6] docs: tweak kernel-doc for QEMU coding standards, Paolo Bonzini, 2019/10/29
- [PATCH 5/6] docs: add memory API reference, Paolo Bonzini, 2019/10/29
- [PATCH 4/6] memory: adjust API documentation to (modified) kerneldoc format, Paolo Bonzini, 2019/10/29
- [PATCH 3/6] docs: disable sphinx warning about missing cross references,
Paolo Bonzini <=
- [PATCH 6/6] memory: include MemoryListener documentation and some missing function parameters, Paolo Bonzini, 2019/10/29
- [PATCH 1/6] docs: import Linux kernel-doc script and extension, Paolo Bonzini, 2019/10/29
- Re: [RFC PATCH 0/6] docs: integrate doc comments with Sphinx build, no-reply, 2019/10/29
- Re: [RFC PATCH 0/6] docs: integrate doc comments with Sphinx build, Peter Maydell, 2019/10/29