From patchwork Tue Mar 5 17:21:38 2019 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Peter Maydell X-Patchwork-Id: 10839775 Return-Path: Received: from mail.wl.linuxfoundation.org (pdx-wl-mail.web.codeaurora.org [172.30.200.125]) by pdx-korg-patchwork-2.web.codeaurora.org (Postfix) with ESMTP id 5A87617E0 for ; Tue, 5 Mar 2019 17:39:46 +0000 (UTC) Received: from mail.wl.linuxfoundation.org (localhost [127.0.0.1]) by mail.wl.linuxfoundation.org (Postfix) with ESMTP id 412362C99C for ; Tue, 5 Mar 2019 17:39:46 +0000 (UTC) Received: by mail.wl.linuxfoundation.org (Postfix, from userid 486) id 3238D2C9BE; Tue, 5 Mar 2019 17:39:46 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.3.1 (2010-03-16) on pdx-wl-mail.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-2.7 required=2.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,MAILING_LIST_MULTI autolearn=ham version=3.3.1 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) by mail.wl.linuxfoundation.org (Postfix) with ESMTPS id 1DCB52C99C for ; Tue, 5 Mar 2019 17:39:45 +0000 (UTC) Received: from localhost ([127.0.0.1]:46741 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1E2a-00083e-FT for patchwork-qemu-devel@patchwork.kernel.org; Tue, 05 Mar 2019 12:39:44 -0500 Received: from eggs.gnu.org ([209.51.188.92]:35697) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h1DlP-0002Kx-JU for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:22:00 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1h1DlO-0001KO-Nh for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:59 -0500 Received: from mail-wr1-x42c.google.com ([2a00:1450:4864:20::42c]:39093) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1h1DlO-0001Gk-GZ for qemu-devel@nongnu.org; Tue, 05 Mar 2019 12:21:58 -0500 Received: by mail-wr1-x42c.google.com with SMTP id l5so10353399wrw.6 for ; Tue, 05 Mar 2019 09:21:58 -0800 (PST) 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=ZOZTZ5+1lHRBHfARGq8GqX/LlU3VKuLBCfBjT8nwCCU=; b=Fi2ohhzShoafwPraOJZLkBEbdAVXLiEJGGr1nCbiFIbNb7GKokSDMVt2NNrU2sMMMS 9USuUuml+tuCNkX/C8i86S+kllQ8Zl/MrV1a3M6nxkqKqlBwwSV/Hi1qrEkkyxtzXNLH 0twKBN63Lybfm+/sapkRbU7uXaijE+zG6cIXehl8UJoJx4nHaS6BTQ8XfKUKpA+/Fkgc 094E43Lx96SuY6HmIunI9NBEgwI+XGCcKFaykjZUVj/UDmpouFly1pMsNuYLGZFOfBfu lvf4Caglyp9nKpuboP9ApQtEF5uiEz35/3TilUiDG9f3J2zHtO4Xb3L7GAegt1E7NXcO W1tQ== 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=ZOZTZ5+1lHRBHfARGq8GqX/LlU3VKuLBCfBjT8nwCCU=; b=ZOkbvf3ugFNNcinaS1ye1j8gs9vrG++SHKpjuJS47iP/MUcTOBYC252ScmzyTnj8jm 5pa7TCVKmH9v+ihptBokBbNWEN/gOSggI0mJB3g+uaKrYtD1zyDyg2PP67hzjjaWIoUi aAP9L3ixu36NA7Ewi8PHeff+b0a8D5seyko7Qo/58YQOzWm7zCMuqpNKUrildf/9sEN/ G8BfDjp7VEw+Tq5wPGsMmsvEzZZL1bH3RPx+Twt6WnQ68ZIVWEOFDz3GO4TvjJXnPgKC xwtolVo5cVy8mz5baTziSsZT33/qkBwmlDMUdeSTblD6YAalZQaYdSysWVEcu3OymMf/ ETNQ== X-Gm-Message-State: APjAAAVFbeYUPf9PbuEezcv8pb4jEY1v8U7y1REJ0UMchxaXGRGexZ+/ shJIkpfCqoHipFLFvmy27hoWTs8T2lk= X-Google-Smtp-Source: APXvYqzHm5qf3rnJfIJe3Nd1u7EYdwWQTddBUmAklMNfLQvShu2hcywDjh/vpHCSCylp05FbBqS/qg== X-Received: by 2002:adf:ee0f:: with SMTP id y15mr16640040wrn.197.1551806517374; Tue, 05 Mar 2019 09:21:57 -0800 (PST) Received: from orth.archaic.org.uk (orth.archaic.org.uk. [81.2.115.148]) by smtp.gmail.com with ESMTPSA id b195sm48289wmg.36.2019.03.05.09.21.55 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Tue, 05 Mar 2019 09:21:56 -0800 (PST) From: Peter Maydell To: qemu-devel@nongnu.org Date: Tue, 5 Mar 2019 17:21:38 +0000 Message-Id: <20190305172139.32662-12-peter.maydell@linaro.org> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20190305172139.32662-1-peter.maydell@linaro.org> References: <20190305172139.32662-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::42c Subject: [Qemu-devel] [PATCH v3 11/12] docs/conf.py: Don't hard-code QEMU version 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: =?utf-8?q?Alex_Benn=C3=A9e?= , =?utf-8?q?Philipp?= =?utf-8?q?e_Mathieu-Daud=C3=A9?= , Aleksandar Markovic Errors-To: qemu-devel-bounces+patchwork-qemu-devel=patchwork.kernel.org@nongnu.org Sender: "Qemu-devel" X-Virus-Scanned: ClamAV using ClamSMTP Don't hard-code the QEMU version number into conf.py. Instead we either pass it to sphinx-build on the command line, or (if doing a standalone Sphinx run in a readthedocs.org setup) extract it from the VERSION file. Signed-off-by: Peter Maydell Reviewed-by: Alex Bennée Reviewed-by: Philippe Mathieu-Daudé Tested-by: Philippe Mathieu-Daudé Acked-by: Aleksandar Markovic Message-id: 20190228145624.24885-12-peter.maydell@linaro.org Reviewed-by: Richard Henderson --- Makefile | 2 +- docs/conf.py | 21 ++++++++++++++++----- 2 files changed, 17 insertions(+), 6 deletions(-) diff --git a/Makefile b/Makefile index 0f5fdc2d2b2..6b3732d114f 100644 --- a/Makefile +++ b/Makefile @@ -869,7 +869,7 @@ docs/version.texi: $(SRC_PATH)/VERSION sphinxdocs: docs/devel/index.html docs/interop/index.html # Canned command to build a single manual -build-manual = $(call quiet-command,sphinx-build $(if $(V),,-q) -b html -d .doctrees/$1 $(SRC_PATH)/docs/$1 docs/$1 ,"SPHINX","docs/$1") +build-manual = $(call quiet-command,sphinx-build $(if $(V),,-q) -b html -D version=$(VERSION) -D release="$(FULL_VERSION)" -d .doctrees/$1 $(SRC_PATH)/docs/$1 docs/$1 ,"SPHINX","docs/$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 diff --git a/docs/conf.py b/docs/conf.py index f452e424cfe..befbcc6c3e1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -76,11 +76,22 @@ author = u'The QEMU Project Developers' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. -# -# The short X.Y version. -version = u'4.0' -# The full version, including alpha/beta/rc tags. -release = u'4.0' + +# Extract this information from the VERSION file, for the benefit of +# standalone Sphinx runs as used by readthedocs.org. Builds run from +# the Makefile will pass version and release on the sphinx-build +# command line, which override this. +try: + extracted_version = None + with open(os.path.join(qemu_docdir, '../VERSION')) as f: + extracted_version = f.readline().strip() +except: + pass +finally: + if extracted_version: + version = release = extracted_version + else: + version = release = "unknown version" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages.