From patchwork Wed Jul 31 08:31:31 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Thomas Monjalon X-Patchwork-Id: 142783 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 8CF09456FF; Wed, 31 Jul 2024 10:45:23 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 1D28240DD7; Wed, 31 Jul 2024 10:45:19 +0200 (CEST) Received: from fhigh2-smtp.messagingengine.com (fhigh2-smtp.messagingengine.com [103.168.172.153]) by mails.dpdk.org (Postfix) with ESMTP id 72BFA40652 for ; Wed, 31 Jul 2024 10:33:41 +0200 (CEST) Received: from compute2.internal (compute2.nyi.internal [10.202.2.46]) by mailfhigh.nyi.internal (Postfix) with ESMTP id 25E391146E53; Wed, 31 Jul 2024 04:33:41 -0400 (EDT) Received: from mailfrontend2 ([10.202.2.163]) by compute2.internal (MEProxy); Wed, 31 Jul 2024 04:33:41 -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=1722414821; x= 1722501221; bh=9YIPDIVQSPCKNl7eeKT/6eZGc7xY7LYestTZnQkvbNk=; b=l flpnT6ykL4yPQGogWS1iXgFHdvFdR3ANaQ1OPfM/I/GxZ/UTbfAk0ZdbSQ9MOlsx dNtjlhbWrvIfII+vYFQz5NhtnqVuLJB9VKjFgeAYDrcfcW+x6BCjpBSBnyN+4QLN x7SrdGmk3kFSI9Cq+fyEorSKFkEsE3Qju65OGiMRNBx7Ecdr7VzI8i/BXN6X1YEH DH9g+IFgS2Ehb6jLFW0yFB3BzqoBgxWlLQ+jklCgonIjD8et6q+774mebqSv3DbB 5X19YM2wR04JJUDK++8fAdAyR5QIDyTB7RIkMiBIcpBUqGJd5uHEao1cDnhUcOvO WDDFhC4CQBH0KRNiF0yfg== 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=1722414821; x= 1722501221; bh=9YIPDIVQSPCKNl7eeKT/6eZGc7xY7LYestTZnQkvbNk=; b=o ajFBc8DyNp94XRrMpRYKi4lpEbmo214K+szwSgEjoLIy45uhjeMqvGQCFx5lRg6y gtGs2n3M6SFUwDKZpJ8rAajMmOFyjPE+GWwzA+EtYVgKjiEtvAOI4lKtSpdzFKUm uQPF+21BWehhrTXSXZhzloqYx80kUqY0bMfWY4E4sfhtVIyFtXUSPi46Ylq0tW3x v3uLmbnMHPXkV8jRSnzZQC+Mk4LhwgQaLozMYtbiP7uKsTgKXJYcnCD4JFh9NoEk obtpc5t9pFvB/86ZWoo7fPofCRVJNhto/rI6W3PmLjnaKN0ntZAt309GdFZTVK1C Nwb7dGOJffQVEfKOMOnAQ== X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeeftddrjeeigddthecutefuodetggdotefrodftvf curfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfghnecu uegrihhlohhuthemuceftddtnecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenuc fjughrpefhvfevufffkffojghfggfgsedtkeertdertddtnecuhfhrohhmpefvhhhomhgr shcuofhonhhjrghlohhnuceothhhohhmrghssehmohhnjhgrlhhonhdrnhgvtheqnecugg ftrfgrthhtvghrnhepvdejhfdugeehvddtieejieegteeuudfgjeeukeeiledthfetveek hefhieelhfdtnecuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehmrghilhhfrh homhepthhhohhmrghssehmohhnjhgrlhhonhdrnhgvthdpnhgspghrtghpthhtoheptd X-ME-Proxy: Feedback-ID: i47234305:Fastmail Received: by mail.messagingengine.com (Postfix) with ESMTPA; Wed, 31 Jul 2024 04:33:40 -0400 (EDT) From: Thomas Monjalon To: dev@dpdk.org Cc: Bruce Richardson Subject: [PATCH v2 1/2] doc: copy custom CSS on guides build Date: Wed, 31 Jul 2024 10:31:31 +0200 Message-ID: <20240731083332.709421-2-thomas@monjalon.net> X-Mailer: git-send-email 2.45.0 In-Reply-To: <20240731083332.709421-1-thomas@monjalon.net> References: <20240721095351.355639-1-thomas@monjalon.net> <20240731083332.709421-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 Acked-by: Ferruh Yigit Tested-by: Ferruh Yigit --- v2: create destination directory in case RtD theme is unavailable --- buildtools/call-sphinx-build.py | 10 ++++++++++ doc/guides/meson.build | 2 -- 2 files changed, 10 insertions(+), 2 deletions(-) diff --git a/buildtools/call-sphinx-build.py b/buildtools/call-sphinx-build.py index da19e950c9..623e7363ee 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,12 @@ 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): + os.makedirs(os.path.dirname(dst_css), exist_ok=True) + 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 Wed Jul 31 08:31:32 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Thomas Monjalon X-Patchwork-Id: 142784 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 94C28456FF; Wed, 31 Jul 2024 10:45:30 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 4E43940E11; Wed, 31 Jul 2024 10:45:20 +0200 (CEST) Received: from fhigh2-smtp.messagingengine.com (fhigh2-smtp.messagingengine.com [103.168.172.153]) by mails.dpdk.org (Postfix) with ESMTP id 9EA7940652 for ; Wed, 31 Jul 2024 10:33:43 +0200 (CEST) Received: from compute2.internal (compute2.nyi.internal [10.202.2.46]) by mailfhigh.nyi.internal (Postfix) with ESMTP id 55B761146E5E; Wed, 31 Jul 2024 04:33:43 -0400 (EDT) Received: from mailfrontend2 ([10.202.2.163]) by compute2.internal (MEProxy); Wed, 31 Jul 2024 04:33:43 -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=1722414823; x= 1722501223; bh=KnRAYap9nc7KKVpSNPoKvdaLkNlqi7PJBM0Hfwk2Swg=; b=q nYdtg5vmLYZOKj1Pim7n6szCJH+9oqGtE6SPmOioukAztFbWO3Vsp6QU1KUFm1oJ Ej12O9mICsNqXPX83LH02dzlmItZktJ6AvvT0cl8SyKTrlyzHVVO5Sib/UQ9+qAq N+OxxtGHaGmwL7IcMTS95MqAa1fEInSZrJYgjoucbDR2IWxf4f8U1pRee4vNgTow hGWsdYtyMIcQ/6UGeyvMW0fvNvO+aFpLQvL4jbfCVEITN94xAZf8L8uX6mgZtiUF FUw3IBchBkkmkcvQx6edALmpT1sKOqVOpbFeosnuaZ9uNgP8BFaLd1Zp7b+JLMzE jDOJwMtXbnj9m3Yc3tiZg== 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=1722414823; x=1722501223; bh=KnRAYap9nc7KK VpSNPoKvdaLkNlqi7PJBM0Hfwk2Swg=; b=hPiYUk9Vgf+qi0Oa6HahplBo9JnJM 4JSpkaVCM15PoRBXmFGjslCXraHDeN1BO3NO62fu6DVpSI84GpfJM0MnK9vPXFw8 IHSLNH72ltnFR/jbsVwsy8CgTbC0ncddGSLsDwYG3xjq5BdSxntvM/d2wDqJjtKZ zy4FqDNDXOE/a2UtONS7HCk4EZzeno0WWSznQpje1kamPMVus0Qee5enuZxyLdCM +emtVbLKh5iLPeSPwLjfxyH5DBGpItulE6DcP+WQ82gy4Qn97Px8YCkNOXe4XqG8 Qfb831CeCOaMsQoozFCj4aUy7BVdj1Us9SRITdLFjFrTqOm8572SkXd+A== X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeeftddrjeeigddthecutefuodetggdotefrodftvf curfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfghnecu uegrihhlohhuthemuceftddtnecunecujfgurhephffvufffkffojghfggfgsedtkeertd ertddtnecuhfhrohhmpefvhhhomhgrshcuofhonhhjrghlohhnuceothhhohhmrghssehm ohhnjhgrlhhonhdrnhgvtheqnecuggftrfgrthhtvghrnhepvdehgfeivdejgedtveehfe fhteelfefgieevgfffveefjeegtdfguedthedtgeevnecuvehluhhsthgvrhfuihiivgep tdenucfrrghrrghmpehmrghilhhfrhhomhepthhhohhmrghssehmohhnjhgrlhhonhdrnh gvthdpnhgspghrtghpthhtoheptd X-ME-Proxy: Feedback-ID: i47234305:Fastmail Received: by mail.messagingengine.com (Postfix) with ESMTPA for ; Wed, 31 Jul 2024 04:33:42 -0400 (EDT) From: Thomas Monjalon To: dev@dpdk.org Subject: [PATCH v2 2/2] doc: give full width to NIC overview page Date: Wed, 31 Jul 2024 10:31:32 +0200 Message-ID: <20240731083332.709421-3-thomas@monjalon.net> X-Mailer: git-send-email 2.45.0 In-Reply-To: <20240731083332.709421-1-thomas@monjalon.net> References: <20240721095351.355639-1-thomas@monjalon.net> <20240731083332.709421-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 --- v2: no change --- 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