From patchwork Thu Nov 19 10:41:56 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: "Burakov, Anatoly" X-Patchwork-Id: 84362 X-Patchwork-Delegate: david.marchand@redhat.com 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 B6D59A04DD; Thu, 19 Nov 2020 11:42:04 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 229333B5; Thu, 19 Nov 2020 11:42:02 +0100 (CET) Received: from mga01.intel.com (mga01.intel.com [192.55.52.88]) by dpdk.org (Postfix) with ESMTP id B4E8F23D for ; Thu, 19 Nov 2020 11:41:59 +0100 (CET) IronPort-SDR: TqEqTj4kug9VAnomtYBHyPLxnKai/IwfAfqEDXwRFXHutFCacN59/Kg5YZCSaTFBB0x2ZxXe2Q z7lD7U3CRrtg== X-IronPort-AV: E=McAfee;i="6000,8403,9809"; a="189354756" X-IronPort-AV: E=Sophos;i="5.77,490,1596524400"; d="scan'208";a="189354756" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga003.jf.intel.com ([10.7.209.27]) by fmsmga101.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 19 Nov 2020 02:41:57 -0800 IronPort-SDR: NRoqtKdZJqe+9FGfcXdRUAzTvM7PH6e+gfPg1vxeWIrDD+XJzV1tfTNXh9kA84p8CCxh91Seah Af6HAXQDnGPg== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,490,1596524400"; d="scan'208";a="325939087" Received: from silpixa00399498.ir.intel.com (HELO silpixa00399498.ger.corp.intel.com) ([10.237.222.52]) by orsmga003.jf.intel.com with ESMTP; 19 Nov 2020 02:41:56 -0800 From: Anatoly Burakov To: dev@dpdk.org Cc: thomas@monjalon.net, bruce.richardson@intel.com Date: Thu, 19 Nov 2020 10:41:56 +0000 Message-Id: <027ca076ea8e2be6bd76987da23298ffd5db550f.1605782511.git.anatoly.burakov@intel.com> X-Mailer: git-send-email 2.17.1 Subject: [dpdk-dev] [PATCH] doc: allow sphinx build with no DPDK version 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 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'