From patchwork Tue May 21 12:25:12 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 164717 Delivered-To: patch@linaro.org Received: by 2002:a92:9e1a:0:0:0:0:0 with SMTP id q26csp1536201ili; Tue, 21 May 2019 05:26:08 -0700 (PDT) X-Google-Smtp-Source: APXvYqyiMPIEHeqBT+4CfHcRmT8ZcPP1IDrRb8Qaw/9H0lh+/VKQQW5gAQQmX61AAd7REd/I6aE+ X-Received: by 2002:a50:f593:: with SMTP id u19mr82096192edm.37.1558441568598; Tue, 21 May 2019 05:26:08 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1558441568; cv=none; d=google.com; s=arc-20160816; b=rPSnJPp8xMmXjj/SW3K5dV2Q7cCKa1avNt9O6FOIIFH61isT/SbJ6dj2Ca1AeKb/Ze fdLDdCP2S6mdkLF5QAwrSTD0DXskuoEWY9bTXEbTojGrk3As9u200SEY6epfveD6+FxG Jb6hjZsL4SOEakvH7qZdG1/384mV7P4cZIKwyKqJ7srJDNVPZwUYzG0wsn/HHbvA7+2b SE4lBqNQs2X7G6Lgo9YXiZHdlRFgZLB8SREFCG8TeYMSh+h2690bcAwhPkw4+HM//AQ6 mb39QWlfQyxFbQJfMJdEUJBbnV4Ku3PZb4oI7MTaRujBSU6X+36bDvUPsrnhaPymUxJD Skog== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:cc:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:subject :content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:to:from:dkim-signature; bh=/E+PaSgrUlg3SFZHIuAu/lXW6yDb2qBLwoSSs8XJ8AE=; b=cXmDCTui6LeCNkoS17mAzbXjNTDVVIYiqP7G8Ag/INeyGjogglePjxuIUhS+pf7Jak vDk0D+fJhWjY5adir836HfA3Nbc17YsvF5DYBxQcTfSKdGjLZMtGyqLL+/LiyEAmhij0 znwPTu5DZhLa1cXJrSRD943caQxA33IH9AnsezLkR/nTFjA2XULhTOlooqUlWwHmpbQx IS8JlbK3jPke688uhFGkT5D9qilyCPH89Y0a5/i8k/F4skOSK9/q9mqTcZP45DSw9IZN MfzmMWIPqV5sj47FKDtXnzrc4mYu/4n+2HEaF0ju8rS/zyNndQC3v9QLFzZAIQ9HVWM7 v4gQ== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=woYXkPI3; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Return-Path: Received: from lists.gnu.org (lists.gnu.org. [209.51.188.17]) by mx.google.com with ESMTPS id x28si15285237edd.32.2019.05.21.05.26.08 for (version=TLS1 cipher=AES128-SHA bits=128/128); Tue, 21 May 2019 05:26:08 -0700 (PDT) Received-SPF: pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; Authentication-Results: mx.google.com; dkim=fail header.i=@linaro.org header.s=google header.b=woYXkPI3; spf=pass (google.com: domain of qemu-devel-bounces+patch=linaro.org@nongnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom="qemu-devel-bounces+patch=linaro.org@nongnu.org"; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=linaro.org Received: from localhost ([127.0.0.1]:52667 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hT3qJ-0001Qj-Dj for patch@linaro.org; Tue, 21 May 2019 08:26:07 -0400 Received: from eggs.gnu.org ([209.51.188.92]:45251) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1hT3py-0001P4-3i for qemu-devel@nongnu.org; Tue, 21 May 2019 08:25:47 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1hT3pw-0005Fr-Tm for qemu-devel@nongnu.org; Tue, 21 May 2019 08:25:46 -0400 Received: from mail-wm1-x32f.google.com ([2a00:1450:4864:20::32f]:40122) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1hT3pw-00055e-M6 for qemu-devel@nongnu.org; Tue, 21 May 2019 08:25:44 -0400 Received: by mail-wm1-x32f.google.com with SMTP id 15so2679193wmg.5 for ; Tue, 21 May 2019 05:25:28 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=linaro.org; s=google; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=/E+PaSgrUlg3SFZHIuAu/lXW6yDb2qBLwoSSs8XJ8AE=; b=woYXkPI33taUXzNCellJQiMx4dJlvYOHYHquJieBhU0SL6NDBJHRELujQpegBSR5P6 2vjq5ZnHbtyYWTbYtfOJ9t2jrQWrN9PaqMzxDMeCqkGznCsgybv7gmOG478DTDBIKrpj DJGh41W2kwiOPLhUfG5CVneJNQ/l0T0jwXHvlsXHcOtStQILelU/HHcL7+9n0HWCCr0A T5sDarpB3Exsco8HL2s3Vju3xHPsKYKMXDH2/660JwsDiaHhzk16T7iTdnLihOs78zF5 04aFwTB0B+Gdnv00x4PKGX+leVmsXCdIJVCFvz/J7fLQ6KQxKdPqY1ilb5XgVrdFfaT/ GgHw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=/E+PaSgrUlg3SFZHIuAu/lXW6yDb2qBLwoSSs8XJ8AE=; b=Xqcz4ZTtGrclnJMbi6KFxlAZWHPJtURTvclZriUxrcXLUt8KvdCyBkrURU/XBozfRq HnLK5tGbLXKoz8nvE8yDPIp67es3W7nPV9wOYv9I8xTFoajT7HFKXJz3xTUKOEs1ek8x ab3OGphkM1LHOJlR8LP787x0kPRTuua6I9hJZiLN85enO2HoxCvuvtykudOjHb9AQSPx GaUkyz304qwbnL7LaLzfsRb44CQctukYGLEo7E6h1l2aa6/KDomeD34TloYxb/76sY4C O+gMvN8z0cftUWiIFre3+Nf4sGiM59hfeGHa1gCDlHnlmOe56MpLjBgryMEN/N3yK9xY bTZw== X-Gm-Message-State: APjAAAUgH+ZTBcImwi7B8zegjVWK0ek8zj4iDCYZt1e5jZ0T0jxsEEmi jgAbllED8yjVFEblUWhXzZo6FTRmkr0= X-Received: by 2002:a7b:c301:: with SMTP id k1mr2727972wmj.43.1558441527480; Tue, 21 May 2019 05:25:27 -0700 (PDT) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id u11sm12233393wrn.1.2019.05.21.05.25.26 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 21 May 2019 05:25:26 -0700 (PDT) From: Peter Maydell To: qemu-devel@nongnu.org Date: Tue, 21 May 2019 13:25:12 +0100 Message-Id: <20190521122519.12573-4-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190521122519.12573-1-peter.maydell@linaro.org> References: <20190521122519.12573-1-peter.maydell@linaro.org> MIME-Version: 1.0 X-detected-operating-system: by eggs.gnu.org: Genre and OS details not recognized. X-Received-From: 2a00:1450:4864:20::32f Subject: [Qemu-devel] [RFC 03/10] docs/conf.py: Enable use of kerneldoc sphinx extension X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: "Daniel P. Berrange" , Eduardo Habkost , Gabriel Barreto , "Emilio G. Cota" , Stefan Hajnoczi , Cleber Rosa , Paolo Bonzini , John Snow Errors-To: qemu-devel-bounces+patch=linaro.org@nongnu.org Sender: "Qemu-devel" Signed-off-by: Peter Maydell --- docs/conf.py | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) -- 2.20.1 diff --git a/docs/conf.py b/docs/conf.py index befbcc6c3e1..9109edbcb97 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -41,8 +41,7 @@ except NameError: # add these directories to sys.path here. If the directory is relative to the # documentation root, use an absolute path starting from qemu_docdir. # -# sys.path.insert(0, os.path.join(qemu_docdir, "my_subdir")) - +sys.path.insert(0, os.path.join(qemu_docdir, "sphinx")) # -- General configuration ------------------------------------------------ @@ -54,7 +53,7 @@ needs_sphinx = '1.3' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = [] +extensions = ['kerneldoc'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -213,4 +212,10 @@ texinfo_documents = [ ] +# -- Options for configuring kerneldoc extension ------------------------- +# We use paths starting from qemu_docdir here so that you can run +# sphinx-build from anywhere and the kerneldoc extension can still +# find everything. +kerneldoc_bin = os.path.join(qemu_docdir, '../scripts/kernel-doc') +kerneldoc_srctree = os.path.join(qemu_docdir, '..')