qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Paolo Bonzini <pbonzini@redhat.com>
To: qemu-devel@nongnu.org
Cc: peter.maydell@linaro.org
Subject: [PATCH 3/6] docs: disable sphinx warning about missing cross references
Date: Tue, 29 Oct 2019 17:22:45 +0100	[thread overview]
Message-ID: <20191029162248.13383-4-pbonzini@redhat.com> (raw)
In-Reply-To: <20191029162248.13383-1-pbonzini@redhat.com>

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 <pbonzini@redhat.com> # 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




  parent reply	other threads:[~2019-10-29 16:25 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-10-29 16:22 [RFC PATCH 0/6] docs: integrate doc comments with Sphinx build Paolo Bonzini
2019-10-29 16:22 ` [PATCH 1/6] docs: import Linux kernel-doc script and extension Paolo Bonzini
2019-10-29 16:22 ` [PATCH 2/6] docs: tweak kernel-doc for QEMU coding standards Paolo Bonzini
2019-10-29 16:22 ` Paolo Bonzini [this message]
2019-10-29 16:22 ` [PATCH 4/6] memory: adjust API documentation to (modified) kerneldoc format Paolo Bonzini
2019-10-29 16:22 ` [PATCH 5/6] docs: add memory API reference Paolo Bonzini
2019-10-29 16:22 ` [PATCH 6/6] memory: include MemoryListener documentation and some missing function parameters Paolo Bonzini
2019-10-29 18:06 ` [RFC PATCH 0/6] docs: integrate doc comments with Sphinx build no-reply
2019-10-29 18:21 ` Peter Maydell
2019-10-31 23:48   ` Paolo Bonzini

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20191029162248.13383-4-pbonzini@redhat.com \
    --to=pbonzini@redhat.com \
    --cc=peter.maydell@linaro.org \
    --cc=qemu-devel@nongnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).