From patchwork Sun Jul 21 09:15:21 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Thomas Monjalon X-Patchwork-Id: 142564 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id A36D345673; Sun, 21 Jul 2024 11:54:07 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 807804069F; Sun, 21 Jul 2024 11:54:04 +0200 (CEST) Received: from fhigh5-smtp.messagingengine.com (fhigh5-smtp.messagingengine.com [103.168.172.156]) by mails.dpdk.org (Postfix) with ESMTP id D29054068A for ; Sun, 21 Jul 2024 11:54:01 +0200 (CEST) Received: from compute9.internal (compute9.nyi.internal [10.202.2.228]) by mailfhigh.nyi.internal (Postfix) with ESMTP id 638F411402FA; Sun, 21 Jul 2024 05:54:01 -0400 (EDT) Received: from mailfrontend1 ([10.202.2.162]) by compute9.internal (MEProxy); Sun, 21 Jul 2024 05:54:01 -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:in-reply-to:message-id:mime-version:references :reply-to:subject:subject:to:to; s=fm3; t=1721555641; x= 1721642041; bh=13OFi5CGmICy/pVktRaQNhVdV+VoZ3lcUo45AMOHOTc=; b=k 2da6811TKkho3BlK/gTFj0TwVh/90j/iDNwrMswtx+dwIvyTjnUQjEehVXCe8sGz Cx5qorXr7G9eJ2INgil6NN2dSYzQhIkpPQSGheil/pmKCyYw/1Rm/SdbwTufcES7 eMZBL+t2PIeFHr3quZPTjr+/GLNuO9i0wlRunBNOMKtQMXfmMNeSSdVpdvUqzrlZ 6leiEkL6JB1tZIYT6oCiozM56hsbmi6OdcK8dHLJRZ8OeyTA20X+uT0kjJcOCiDl rXXqasbKD2kBx0vMIHGExlE4qe8iYCoP0T/iXkJPGzKXtDgyTOZ6sKlhXbNBdR29 v64G/TAU7Ba5CXjlPNW9A== 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:in-reply-to:message-id:mime-version:references :reply-to:subject:subject:to:to:x-me-proxy:x-me-proxy :x-me-sender:x-me-sender:x-sasl-enc; s=fm3; t=1721555641; x= 1721642041; bh=13OFi5CGmICy/pVktRaQNhVdV+VoZ3lcUo45AMOHOTc=; b=Q k9oqeXtXnz8h2Zv0TALROoF/x+nQ9lFLrRI0mxzzLzoUef417k0zvxOX13mLv2GR xl/BCopy6iM8xu1faOdUzSYsB04IfJyUizmF7mtBFbiPRZoUlZmw/N0aT5xflAr4 mtjv7LZ4p0Z97eoV+G8CZUrF+dS/pDRxsfEwA9sVvuRM/EjlMcLIC3mYpdj33eT8 061M1dPDVCrjDJARmE70hiv/xJHMhn/A+WcWyeEeHcV9NwjA6GCuhIRpDzRRwU4c +U3zDKHwEih1OjnODTZdG/mi57Z7Aoj53+GnvXWBF+e0At2mLpx2QcSbcxKPvdfZ qeI9shjCnBephz+P7DYBg== X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeeftddrheehgddvvdcutefuodetggdotefrodftvf curfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfghnecu uegrihhlohhuthemuceftddtnecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenuc fjughrpefhvfevufffkffojghfggfgsedtkeertdertddtnecuhfhrohhmpefvhhhomhgr shcuofhonhhjrghlohhnuceothhhohhmrghssehmohhnjhgrlhhonhdrnhgvtheqnecugg ftrfgrthhtvghrnhepvdejhfdugeehvddtieejieegteeuudfgjeeukeeiledthfetveek hefhieelhfdtnecuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehmrghilhhfrh homhepthhhohhmrghssehmohhnjhgrlhhonhdrnhgvth X-ME-Proxy: Feedback-ID: i47234305:Fastmail Received: by mail.messagingengine.com (Postfix) with ESMTPA; Sun, 21 Jul 2024 05:54:00 -0400 (EDT) From: Thomas Monjalon To: dev@dpdk.org Cc: Bruce Richardson Subject: [PATCH 1/2] doc: copy custom CSS on guides build Date: Sun, 21 Jul 2024 11:15:21 +0200 Message-ID: <20240721095351.355639-2-thomas@monjalon.net> X-Mailer: git-send-email 2.45.0 In-Reply-To: <20240721095351.355639-1-thomas@monjalon.net> References: <20240721095351.355639-1-thomas@monjalon.net> MIME-Version: 1.0 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 The custom CSS file for Sphinx guides was copied during install, but not during build time. Before switching to Meson, the Makefile was copying this file in the build steps, so the doc was complete and viewable from the build directory. It is especially useful to get full documentation in the build directory when building only documentation with "ninja -C build doc". The command "ninja install" was required to get the CSS file installed, but it requires to build the libraries as well. The CSS file is now copied as part of the Sphinx build script, and it will be installed as part of the whole html directory. Signed-off-by: Thomas Monjalon --- buildtools/call-sphinx-build.py | 9 +++++++++ doc/guides/meson.build | 2 -- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/buildtools/call-sphinx-build.py b/buildtools/call-sphinx-build.py index da19e950c9..99e396bdd7 100755 --- a/buildtools/call-sphinx-build.py +++ b/buildtools/call-sphinx-build.py @@ -3,6 +3,8 @@ # Copyright(c) 2019 Intel Corporation # +import filecmp +import shutil import sys import os from os.path import join @@ -30,4 +32,11 @@ with open(join(dst, '.html.d'), 'w') as d: d.write('html: ' + ' '.join(srcfiles) + '\n') +# copy custom CSS file +css = 'custom.css' +src_css = join(src, css) +dst_css = join(dst, 'html', '_static', 'css', css) +if not os.path.exists(dst_css) or not filecmp.cmp(src_css, dst_css): + shutil.copyfile(src_css, dst_css) + sys.exit(process.returncode) diff --git a/doc/guides/meson.build b/doc/guides/meson.build index 51f81da2e3..f8bbfba9f5 100644 --- a/doc/guides/meson.build +++ b/doc/guides/meson.build @@ -24,7 +24,5 @@ html_guides = custom_target('html_guides', install: get_option('enable_docs'), install_dir: htmldir) -install_data(files('custom.css'), install_dir: join_paths(htmldir,'_static', 'css')) - doc_targets += html_guides doc_target_names += 'HTML_Guides' From patchwork Sun Jul 21 09:15:22 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Thomas Monjalon X-Patchwork-Id: 142565 X-Patchwork-Delegate: thomas@monjalon.net Return-Path: X-Original-To: patchwork@inbox.dpdk.org Delivered-To: patchwork@inbox.dpdk.org Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 7DD5945673; Sun, 21 Jul 2024 11:54:14 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id C5A8F40DD8; Sun, 21 Jul 2024 11:54:05 +0200 (CEST) Received: from fhigh5-smtp.messagingengine.com (fhigh5-smtp.messagingengine.com [103.168.172.156]) by mails.dpdk.org (Postfix) with ESMTP id B1DE94014F for ; Sun, 21 Jul 2024 11:54:03 +0200 (CEST) Received: from compute6.internal (compute6.nyi.internal [10.202.2.47]) by mailfhigh.nyi.internal (Postfix) with ESMTP id 4D6DE11402F7; Sun, 21 Jul 2024 05:54:03 -0400 (EDT) Received: from mailfrontend1 ([10.202.2.162]) by compute6.internal (MEProxy); Sun, 21 Jul 2024 05:54:03 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h= cc:content-transfer-encoding:content-type:date:date:from:from :in-reply-to:in-reply-to:message-id:mime-version:references :reply-to:subject:subject:to:to; s=fm3; t=1721555643; x= 1721642043; bh=BFz6IQB7+oDRfP382gmbRzCH3MSCTKFXGvP3Hqoycp4=; b=l K9h/xRilZW4+0kR7RaxdNyf6cE9ty8YchLfuBXDdAlnkZLp65tdv3WGjhrfuV1Y5 pcp3OHty9zot5R0ja683iaCHzBzLAae5ZBvklW9uLeyz1X70hIuaalZ0CiyuzMW/ CiiOtnM2+qDVyPU4qMYCY6mNPIJviAE1IXlOUoVyM1gVYGrk7aWVR6jENpPwgyfE 42DIHmI+27YkkE7yUG2oTVF7Fr3dH30UcHJ0TkfsaeKfdfKB5Jdj+JAzn8lk1w9m VmpfnEJNOJ4Bxjt/OYqFqB+1SvIaJDuY1QxVJPdFhY9+BtfmG2rexNAG8nNXv/0E vT8mAJhOvtsUHXHMKXhKQ== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-transfer-encoding:content-type :date:date:feedback-id:feedback-id:from:from:in-reply-to :in-reply-to:message-id:mime-version:references:reply-to:subject :subject:to:to:x-me-proxy:x-me-proxy:x-me-sender:x-me-sender :x-sasl-enc; s=fm3; t=1721555643; x=1721642043; bh=BFz6IQB7+oDRf P382gmbRzCH3MSCTKFXGvP3Hqoycp4=; b=sYAwLE0MlS+Vadhtu+HARiuXctnzY nqKqiA9CIjKOPx5MKi2/JUTez6CNHO+rC/sh9hCULt1amNAwP1/t08tNNZvFHTVO QTsLeJjoLSFGRlDAjWPZQ1JnjBJ4ymAYeVporr8sS5PYoMDaPGZt69moclQA9qY/ mct1AgV/2OoSMJcBDDTbjApYKOLIHir1LCHiH7G/zgkByqYXxHufKNe7Ici5vtSJ iqKqCUis2kUr/hZ6SHbT7GHf8UkkriJcOE1Ge8H9lAM0Zx8uAnzsh5jX8o8ekhmz rSoAIAPwlIGRFvQ6hz6nc6v0R7xWIMIxzG9SNTmvj/UjrZD0hfbqq1PxA== X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeeftddrheehgddvvdcutefuodetggdotefrodftvf curfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfghnecu uegrihhlohhuthemuceftddtnecunecujfgurhephffvufffkffojghfggfgsedtkeertd ertddtnecuhfhrohhmpefvhhhomhgrshcuofhonhhjrghlohhnuceothhhohhmrghssehm ohhnjhgrlhhonhdrnhgvtheqnecuggftrfgrthhtvghrnhepvdehgfeivdejgedtveehfe fhteelfefgieevgfffveefjeegtdfguedthedtgeevnecuvehluhhsthgvrhfuihiivgep tdenucfrrghrrghmpehmrghilhhfrhhomhepthhhohhmrghssehmohhnjhgrlhhonhdrnh gvth X-ME-Proxy: Feedback-ID: i47234305:Fastmail Received: by mail.messagingengine.com (Postfix) with ESMTPA for ; Sun, 21 Jul 2024 05:54:02 -0400 (EDT) From: Thomas Monjalon To: dev@dpdk.org Subject: [PATCH 2/2] doc: give full width to NIC overview page Date: Sun, 21 Jul 2024 11:15:22 +0200 Message-ID: <20240721095351.355639-3-thomas@monjalon.net> X-Mailer: git-send-email 2.45.0 In-Reply-To: <20240721095351.355639-1-thomas@monjalon.net> References: <20240721095351.355639-1-thomas@monjalon.net> MIME-Version: 1.0 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 The wide tables in the NIC overview exceed the normal page width because of the large number of drivers. A CSS trick is added to allow displaying this page in the full width of the browser window. Signed-off-by: Thomas Monjalon --- doc/guides/custom.css | 8 ++++++++ doc/guides/nics/overview.rst | 2 ++ 2 files changed, 10 insertions(+) diff --git a/doc/guides/custom.css b/doc/guides/custom.css index 221024655c..df1a52f1d4 100644 --- a/doc/guides/custom.css +++ b/doc/guides/custom.css @@ -4,6 +4,14 @@ /* Override readthedocs theme */ +/* Set full width on a page. + * Usage: insert the following line in the doc. + * .. rst-class:: widepage + */ +.wy-nav-content:has(.widepage) { + max-width: none !important; +} + /* Spacing before a list item must be bigger than spacing inside the item. * Complex list items start with a p.first element. */ .section li > .first { diff --git a/doc/guides/nics/overview.rst b/doc/guides/nics/overview.rst index 67575c699c..4553076481 100644 --- a/doc/guides/nics/overview.rst +++ b/doc/guides/nics/overview.rst @@ -24,6 +24,8 @@ Most of these differences are summarized below. More details about features can be found in :doc:`features`. +.. rst-class:: widepage + .. _table_net_pmd_features: .. include:: overview_table.txt