From patchwork Fri Nov 20 16:41:04 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Burakov, Anatoly" X-Patchwork-Id: 84439 Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id AC687A04DD; Fri, 20 Nov 2020 17:41:17 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 1AF7E4C90; Fri, 20 Nov 2020 17:41:16 +0100 (CET) Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by dpdk.org (Postfix) with ESMTP id 77493F90 for ; Fri, 20 Nov 2020 17:41:14 +0100 (CET) IronPort-SDR: fOfAgq9EiNYtuTm16wzc+6a8+Yxi5/mowd8P7q7Itx3AKE83Xohb/MVgCl2Y2MMk4sGw3IXTqJ 44/Gp9XzWc8A== X-IronPort-AV: E=McAfee;i="6000,8403,9810"; a="168931087" X-IronPort-AV: E=Sophos;i="5.78,357,1599548400"; d="scan'208";a="168931087" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga004.jf.intel.com ([10.7.209.38]) by fmsmga104.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 20 Nov 2020 08:41:09 -0800 IronPort-SDR: XfO5sHuzrFliea2iOQ4wUsKZQtcz+XEQOmvgOsvCjFkVQsySjTro3aYmh4j/Q9UDtzZ+4zhQL1 asoBeolgVX2g== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.78,357,1599548400"; d="scan'208";a="477283628" Received: from silpixa00399498.ir.intel.com (HELO silpixa00399498.ger.corp.intel.com) ([10.237.222.52]) by orsmga004.jf.intel.com with ESMTP; 20 Nov 2020 08:41:04 -0800 From: Anatoly Burakov To: dev@dpdk.org Cc: ferruh.yigit@intel.com, thomas@monjalon.net Date: Fri, 20 Nov 2020 16:41:04 +0000 Message-Id: <7bda955f729dd450e5cd63e93962df37de4ee91b.1605890459.git.anatoly.burakov@intel.com> X-Mailer: git-send-email 2.17.1 Subject: [dpdk-dev] [PATCH DPDK-KMODS] doc: allow external build X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Currently, when building sphinx documentation, the build will only succeed if being run from the build system, because the conf.py script expects DPDK_VERSION environment variable to be set, and crashes if it is not. However, there are certain external tools (such as sphinx documentation preview extensions for certain IDE's) that use live preview and thus rely on running their own sphinx commands. In these cases, it is useful to permit building sphinx documentation without specifying the DPDK_VERSION environment variable. The version string is the only thing preventing manual sphinx build commands from working. Fix the conf.py to use "None" as a version string in cases when DPDK_VERSION environment variable is not set. Signed-off-by: Anatoly Burakov Acked-by: Bruce Richardson --- doc/guides/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/guides/conf.py b/doc/guides/conf.py index 9de490e1c4..aceeb62a4f 100644 --- a/doc/guides/conf.py +++ b/doc/guides/conf.py @@ -36,7 +36,7 @@ html_show_copyright = False highlight_language = 'none' -release = environ['DPDK_VERSION'] +release = environ.setdefault('DPDK_VERSION', "None") version = release master_doc = 'index'