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 DD6164576B; Thu, 8 Aug 2024 14:28:03 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 8ADC44279C; Thu, 8 Aug 2024 14:28:03 +0200 (CEST) Received: from fout7-smtp.messagingengine.com (fout7-smtp.messagingengine.com [103.168.172.150]) by mails.dpdk.org (Postfix) with ESMTP id EBD3D42790 for ; Thu, 8 Aug 2024 14:28:01 +0200 (CEST) Received: from compute3.internal (compute3.nyi.internal [10.202.2.43]) by mailfout.nyi.internal (Postfix) with ESMTP id 63F74138E00C; Thu, 8 Aug 2024 08:28:01 -0400 (EDT) Received: from mailfrontend1 ([10.202.2.162]) by compute3.internal (MEProxy); Thu, 08 Aug 2024 08:28:01 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h= cc:cc:content-transfer-encoding:content-type: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=1723120081; x=1723206481; bh=J5XqDwZrTVoLj5czCfgTFOmDe7FTGDPEM9V3gLrL+90=; b= tS3TXfsFhge6PM6U27F4cNN+hAEbO/BZ+r+Mj1thVgrWKSlrLMXt2PNYnXcF/Mqq stlCNf3qtStKlqzWVNiv/0trsLYNAY5Vl0WFiNVhXKfdo7iSR8wrvKx9wsQNaIQg AslmH41Uytv/2g65BMvoipWLqzxa4Ps9Bzz91/ms8vygeiXiU6iTJNGhOr8ak0u6 2s4KO57iRfhsnycTuh6do31QcfGYUmYjLBSKB9ylpZIUR8gTyIL/f+UNs0XouvzO OI2uU/fxIECh3+NWxXoU/kGFCq4KbM6TAb7qEhPNMX3jkIDVTo0weZxh9PDTmDwz PrGT8IfBN0PVhw/+QxloAA== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:cc:content-transfer-encoding :content-type: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=1723120081; x= 1723206481; bh=J5XqDwZrTVoLj5czCfgTFOmDe7FTGDPEM9V3gLrL+90=; b=E Q+5bM4yvy5gTYApLjUWdMUi2QPrEgcgNKDNREi/K5BXyOxrQJUbExf3sXezthZwj aD8c78puk0+VRqlMMKMKpxmjBO+4tf293N7VInDypStCryuoMy+3ricrldsTj69d SvH1S2PU6xZVg7jljmyK1/sIVzJPS6RJtmtvK2PZqUPyLGsHcTyyyaicC9LrSCd7 x0hIYueRBXD9GvMWRvToXZFLW57Wwa3LFGSgYkj+kjEAM17TLRXZLCUTIj2/Gy9c w72Lk1M2a8WnXSAhOwdZXPTPdy8hB/+BMP+eaHP/ENAmC6x+xcwu4akHLfTlaP2f 3+hZ8mo15UnIZDkQVBD9Q== X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeeftddrledvgdehfecutefuodetggdotefrodftvf curfhrohhfihhlvgemucfhrghsthforghilhdpggftfghnshhusghstghrihgsvgdpuffr tefokffrpgfnqfghnecuuegrihhlohhuthemuceftddtnecusecvtfgvtghiphhivghnth hsucdlqddutddtmdenucfjughrpefhvfevufffkfgjfhgggfgtsehtqhertddttdejnecu hfhrohhmpefvhhhomhgrshcuofhonhhjrghlohhnuceothhhohhmrghssehmohhnjhgrlh honhdrnhgvtheqnecuggftrfgrthhtvghrnheplefgudevledujeefvefgkeduieetiedt leehleejvedtjeekgffhgfduvdffgfelnecuffhomhgrihhnpegvgihtrdhfohhonecuve hluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehmrghilhhfrhhomhepthhhohhmrghs sehmohhnjhgrlhhonhdrnhgvthdpnhgspghrtghpthhtohepledpmhhouggvpehsmhhtph houhhtpdhrtghpthhtohepjhhurhgrjhdrlhhinhhkvghssehprghnthhhvghonhdrthgv tghhpdhrtghpthhtohephhhonhhnrghpphgrrdhnrghgrghrrghhrghllhhisegrrhhmrd gtohhmpdhrtghpthhtohepsghruhgtvgdrrhhitghhrghrughsohhnsehinhhtvghlrdgt ohhmpdhrtghpthhtohepjhhsphgvfihotghksehiohhlrdhunhhhrdgvughupdhrtghpth htohepphhrohgssgesihholhdruhhnhhdrvgguuhdprhgtphhtthhopehprghulhdrshii tgiivghprghnvghksegrrhhmrdgtohhmpdhrtghpthhtoheplhhutggrrdhvihiiiigrrh hrohesrghrmhdrtghomhdprhgtphhtthhopehnphhrrghtthgvsehiohhlrdhunhhhrdgv ughupdhrtghpthhtohepuggvvhesughpughkrdhorhhg X-ME-Proxy: Feedback-ID: i47234305:Fastmail Received: by mail.messagingengine.com (Postfix) with ESMTPA; Thu, 8 Aug 2024 08:27:59 -0400 (EDT) From: Thomas Monjalon To: Juraj =?utf-8?B?TGlua2XFoQ==?= Cc: Honnappa.Nagarahalli@arm.com, bruce.richardson@intel.com, jspewock@iol.unh.edu, probb@iol.unh.edu, paul.szczepanek@arm.com, Luca.Vizzarro@arm.com, npratte@iol.unh.edu, dev@dpdk.org Subject: Re: [PATCH v15 5/5] dts: add API doc generation Date: Thu, 08 Aug 2024 14:27:58 +0200 Message-ID: <4561127.8F6SAcFxjW@thomas> In-Reply-To: <16e9f263-f6f9-4724-8111-cdd74f063ea7@pantheon.tech> References: <20231115133606.42081-1-juraj.linkes@pantheon.tech> <14011012.RDIVbhacDa@thomas> <16e9f263-f6f9-4724-8111-cdd74f063ea7@pantheon.tech> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" 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 07/08/2024 15:12, Juraj Linke=C5=A1: > On 7. 8. 2024 14:27, Thomas Monjalon wrote: > > 07/08/2024 14:03, Juraj Linke=C5=A1: > >> On 7. 8. 2024 12:41, Thomas Monjalon wrote: > >>> 06/08/2024 17:19, Juraj Linke=C5=A1: > >>>> --- /dev/null > >>>> +++ b/doc/api/dts/custom.css > >>>> @@ -0,0 +1 @@ > >>>> +../../guides/custom.css > >>>> \ No newline at end of file > >>> > >>> Is it a link? Why? > >>> > >> > >> call-sphinx-build.py copies the custom.css file. I added a link to > >> preserve the look. > >> > >>>> +htmldir =3D join_paths(get_option('datadir'), 'doc', 'dpdk', 'dts') > >>>> +dts_api_html =3D custom_target('dts_api_html', > >>>> + output: 'html', > >>>> + command: [sphinx_wrapper, sphinx, meson.project_version(), > >>>> + meson.current_source_dir(), meson.current_build_dir(), = extra_sphinx_args], > >>>> + build_by_default: get_option('enable_docs'), > >>>> + install: get_option('enable_docs'), > >>>> + install_dir: htmldir) > >>> > >>> When custom.css is copied? > >> > >> I'm not sure what you're asking here. The call-sphinx-build.py copies = it > >> during the build and it's also copied during the install phase. > >=20 > > The file is copied in _static dir of sphinx guides. > > How does it work for DTS API? >=20 > It works the same way. shutil.copyfile (which is used to copy the file)=20 > follows symlinks, so DTS API gets a copy in its _static dir=20 > (doc/api/dts/html/_static/css). > I did it this way to preserve the style in case there's something in the= =20 > css file that applies to both DPDK and DTS API docs. Oh yes. I wrote it 2 weeks ago and already forgot it works with any sphinx path. > >>>> +# Napoleon enables the Google format of Python doscstrings, used in= DTS. > >>>> +# Intersphinx allows linking to external projects, such as Python d= ocs, also used in DTS. > >>>> +extensions =3D ['sphinx.ext.napoleon', 'sphinx.ext.intersphinx'] > >>> > >>> What happens if napoleon and intersphinx are not available > >>> when building basic DPDK doc without DTS? > >> > >> napoleon was added in version 1.3 and intersphinx in 0.5, so I didn't > >> think of testing that. > >> > >> I tried adding a non-existent extension to the list and got this error: > >> Extension error: > >> Could not import extension sphinx.ext.foo (exception: No module named > >> 'sphinx.ext.foo') > >> > >> I could add version checks for each of the extensions. > >=20 > > My concern is to allow generating DPDK doc without DTS, > > without the new extra dependencies. > >=20 >=20 > Ok, I think putting all of these into the DTS if branch ("if=20 > environ.get('DTS_BUILD'):") would make sense then. OK