From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id A55F845B60; Thu, 17 Oct 2024 19:14:31 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 2D82D4025F; Thu, 17 Oct 2024 19:14:31 +0200 (CEST) Received: from fout-a3-smtp.messagingengine.com (fout-a3-smtp.messagingengine.com [103.168.172.146]) by mails.dpdk.org (Postfix) with ESMTP id BB6BA4021E for ; Thu, 17 Oct 2024 19:14:29 +0200 (CEST) Received: from phl-compute-03.internal (phl-compute-03.phl.internal [10.202.2.43]) by mailfout.phl.internal (Postfix) with ESMTP id 28FA213801FF; Thu, 17 Oct 2024 13:14:29 -0400 (EDT) Received: from phl-mailfrontend-01 ([10.202.2.162]) by phl-compute-03.internal (MEProxy); Thu, 17 Oct 2024 13:14:29 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h= cc:cc:content-transfer-encoding:content-type:date:date:from:from :in-reply-to:message-id:mime-version:reply-to:subject:subject:to :to; s=fm2; t=1729185269; x=1729271669; bh=fNVVyS0nQuq5RC/Cj/4BM dG3dQAOSl2nXgbfBS5SCLc=; b=Psfsu/eOQ93e+J8iCW2zoY8Pv088V3NlIXLwr 3UxyhRw5zRTNwJnvtnytcZoklTKu5/mnLmRTf0OSMBie/1R0Jbe0AfJ67lYMVman jHSZsCO8cPS+OCOzzKIkPDoycmXyScKhPB4imUlAdAPOyx2cTDwK1tT8Sxo/A/+K uHb4w8LJ3MrJX8TlRk27nU2aoW7K5ugBPpIq7d1gOFHHrLGJprtIHWLrdWlazJVy vtgE3Fu+djcBZ1nm/ExBrng8527UPR4WG8VAK002kq4EyFk51+Xgj2ofxVYEBQlC rCdkBSLRnLduiJcTX6fwJpvpnVUEmWrN5MoA5EREJTd8tylUg== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:cc:content-transfer-encoding :content-type:date:date:feedback-id:feedback-id:from:from :in-reply-to:message-id:mime-version:reply-to:subject:subject:to :to:x-me-proxy:x-me-proxy:x-me-sender:x-me-sender:x-sasl-enc; s= fm2; t=1729185269; x=1729271669; bh=fNVVyS0nQuq5RC/Cj/4BMdG3dQAO Sl2nXgbfBS5SCLc=; b=RDADPJyykIoi9t+o0amsVbF9h62BPFP+OsajgGAG0tWG 1T4KB4FWLWZgoCKmt69Kmh/Wg3g1LrufpO+xHot505tp/Qpat6YFEWIZqsebwSNm 94QjQoo9vK+3omw7LGoyM7yJhQge683vqHidOZZg/tafwZA8qCd+KJV4MTyOfF1G Y0vGWYoKx1MCPl4+ZpSf0SsLPMxhzdNe3z90gMqtyLuVVQJHQQ6A3Bmpb9xvCQd3 XJhEStQuOOiR4I7eoZcsyKx93Vaf1XYimVZJ6N89ZyS2BLk4ZMNeLOBauJouFzJC Z5caG/jKxliAy6M3yFD6j/GHe7s+S3QHr1FObgpLZw== X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeeftddrvdehuddgudduvdcutefuodetggdotefrod ftvfcurfhrohhfihhlvgemucfhrghsthforghilhdpggftfghnshhusghstghrihgsvgdp uffrtefokffrpgfnqfghnecuuegrihhlohhuthemuceftddtnecusecvtfgvtghiphhivg hnthhsucdlqddutddtmdenucfjughrpefhvfevufffkffoggfgsedtkeertdertddtnecu hfhrohhmpefvhhhomhgrshcuofhonhhjrghlohhnuceothhhohhmrghssehmohhnjhgrlh honhdrnhgvtheqnecuggftrfgrthhtvghrnhepheekleeiheduveelueefkeehudelgedu leehieelueeiuddtffeiledvleejjeetnecuffhomhgrihhnpehrvggrughthhgvughotg hsrdhiohenucevlhhushhtvghrufhiiigvpedtnecurfgrrhgrmhepmhgrihhlfhhrohhm pehthhhomhgrshesmhhonhhjrghlohhnrdhnvghtpdhnsggprhgtphhtthhopeeipdhmoh guvgepshhmthhpohhuthdprhgtphhtthhopeguvghvseguphgukhdrohhrghdprhgtphht thhopehrjhgrrhhrhiesrhgvughhrghtrdgtohhmpdhrtghpthhtohepjhhurhgrjhdrlh hinhhkvghssehprghnthhhvghonhdrthgvtghhpdhrtghpthhtoheplhhutggrrdhvihii iigrrhhrohesrghrmhdrtghomhdprhgtphhtthhopegumhgrrhigsehiohhlrdhunhhhrd gvughupdhrtghpthhtohepjhhsphgvfihotghksehiohhlrdhunhhhrdgvughu X-ME-Proxy: Feedback-ID: i47234305:Fastmail Received: by mail.messagingengine.com (Postfix) with ESMTPA; Thu, 17 Oct 2024 13:14:27 -0400 (EDT) From: Thomas Monjalon To: dev@dpdk.org Cc: Robin Jarry , =?UTF-8?q?Juraj=20Linke=C5=A1?= , Luca Vizzarro , Dean Marx , Jeremy Spewock Subject: [PATCH] doc: fix Sphinx build without RTD theme Date: Thu, 17 Oct 2024 19:14:13 +0200 Message-ID: <20241017171413.2846973-1-thomas@monjalon.net> X-Mailer: git-send-email 2.46.0 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org DTS is using a specific configuration of Sphinx which is supported only with the theme Read The Docs. If not available, this error may be seen: unsupported theme option 'collapse_navigation' given In order to allow doc generation without this theme, a check is added to make the specific configuration optional. Fixes: 7f9326423a04 ("dts: add API doc generation") Signed-off-by: Thomas Monjalon Signed-off-by: Robin Jarry --- doc/guides/conf.py | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/guides/conf.py b/doc/guides/conf.py index 200e98b0bc..b553d9d5bf 100644 --- a/doc/guides/conf.py +++ b/doc/guides/conf.py @@ -16,13 +16,12 @@ try: import sphinx_rtd_theme - html_theme = "sphinx_rtd_theme" -except: +except ImportError: print('Install the sphinx ReadTheDocs theme for improved html documentation ' 'layout: https://sphinx-rtd-theme.readthedocs.io/', file=stderr) - pass + html_theme = "default" stop_on_error = ('-W' in argv) @@ -85,10 +84,11 @@ toc_object_entries = True toc_object_entries_show_parents = 'hide' # DTS Sidebar config. - html_theme_options = { - 'collapse_navigation': False, - 'navigation_depth': -1, # unlimited depth - } + if html_theme == "sphinx_rtd_theme": + html_theme_options = { + 'collapse_navigation': False, + 'navigation_depth': -1, # unlimited depth + } # Add path to DTS sources so that Sphinx can find them. dpdk_root = dirname(dirname(dirname(__file__))) -- 2.46.0