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 ED5B84575D; Wed, 7 Aug 2024 14:27:07 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 895A04028C; Wed, 7 Aug 2024 14:27:07 +0200 (CEST) Received: from fhigh4-smtp.messagingengine.com (fhigh4-smtp.messagingengine.com [103.168.172.155]) by mails.dpdk.org (Postfix) with ESMTP id 08F584027B for ; Wed, 7 Aug 2024 14:27:05 +0200 (CEST) Received: from compute3.internal (compute3.nyi.internal [10.202.2.43]) by mailfhigh.nyi.internal (Postfix) with ESMTP id 6F18E1151A3F; Wed, 7 Aug 2024 08:27:05 -0400 (EDT) Received: from mailfrontend1 ([10.202.2.162]) by compute3.internal (MEProxy); Wed, 07 Aug 2024 08:27:05 -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=1723033625; x=1723120025; bh=dFOc+dJdfYefebTzvRuH37KDzhwCO+jfflbpkDKFPfc=; b= mMcKeYlQGzE34lsQhYGpSHtoMHpiygxNpe2+F6RytlmqzbkOtB05HQehrFYuQFmB YyIMmIkr+1TXqZ1/gmj0482XlgEz5XqwAAqflS+MYaWS+t0cXM2N38gMoDcOJyaY Y4xBwcElsVE5UTS+Gs1/Wvj9RZ0seAWM6KPoO1Oq2iAOSwvqF50jEjU/WboPnEPY wIE5QllpADVmje+/YeqCtL7Q3x96fauUtN2plNduiSVNdc6nhtd6c+fAteRhONa5 TFziXn6Oru72UoqO43ou9a7ilGhH26t7Y5ZkfvbNEH8/tCA4oa88hdY6X61Nux08 jTPNryrVNNoHyUyzlwKFcA== 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=1723033625; x= 1723120025; bh=dFOc+dJdfYefebTzvRuH37KDzhwCO+jfflbpkDKFPfc=; b=L e7IYjzCFd/Ed7sOf543kJb0K7w+i2NvpH8UoximAtjlRzJ1AvKTVa2sgRKo6M2RJ bKxHZ3JphB89C1fWYy4l//U99qybd1wMbjXax9QjqKXcVDe3Xv82Y2r+A2EmIcSy Scz9fWc8a26tkfny8SuJTJD/IXP5IaolY4q/5n+JUwIuX0CkBPytM43tQB9xTW47 tUWcQchYxDQkjW856Dvf1RiZ8a3N7JxpFNgES2jg2Z6uKJMmOFLD5htTj3OfBlGE kznbpbrIFtsel96PQSG0Olo2xeDcBk6jsQjrzflJ9Z8m98GeACWTTgJsoF7KIOxm G4zf+oVTW2mN+nlzOxFyQ== X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeeftddrledtgdehvdcutefuodetggdotefrodftvf curfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfghnecu uegrihhlohhuthemuceftddtnecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenuc fjughrpefhvfevufffkfgjfhgggfgtsehtqhertddttdejnecuhfhrohhmpefvhhhomhgr shcuofhonhhjrghlohhnuceothhhohhmrghssehmohhnjhgrlhhonhdrnhgvtheqnecugg ftrfgrthhtvghrnheplefgudevledujeefvefgkeduieetiedtleehleejvedtjeekgffh gfduvdffgfelnecuffhomhgrihhnpegvgihtrdhfohhonecuvehluhhsthgvrhfuihiivg eptdenucfrrghrrghmpehmrghilhhfrhhomhepthhhohhmrghssehmohhnjhgrlhhonhdr nhgvthdpnhgspghrtghpthhtoheptd X-ME-Proxy: Feedback-ID: i47234305:Fastmail Received: by mail.messagingengine.com (Postfix) with ESMTPA; Wed, 7 Aug 2024 08:27:03 -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: Wed, 07 Aug 2024 14:27:01 +0200 Message-ID: <14011012.RDIVbhacDa@thomas> In-Reply-To: <9dfa8755-520b-42af-890c-30a3ff74f3a1@pantheon.tech> References: <20231115133606.42081-1-juraj.linkes@pantheon.tech> <2156393.OBFZWjSADL@thomas> <9dfa8755-520b-42af-890c-30a3ff74f3a1@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 14:03, Juraj Linke=C5=A1: > On 7. 8. 2024 12:41, Thomas Monjalon wrote: > > 06/08/2024 17:19, Juraj Linke=C5=A1: > > [...] > >> +get_dts_deps =3D py3 + files('get-dts-deps.py') > >=20 > > deps for runtime or doc? > > may be good to specify in the name > >=20 >=20 > It's getting both, actually. > Now that I think about it, we don't need to get the docs dependencies,=20 > as we check for Sphinx elsewhere. We really only need to get the runtime= =20 > dependencies and mock what's missing (that is add those to the=20 > autodoc_mock_imports config option). >=20 > I think it makes sense to change the script and rename it to=20 > get-dts-runtime-deps.py (and the variable). OK > >> --- /dev/null > >> +++ b/doc/api/dts/custom.css > >> @@ -0,0 +1 @@ > >> +../../guides/custom.css > >> \ No newline at end of file > >=20 > > Is it a link? Why? > >=20 >=20 > call-sphinx-build.py copies the custom.css file. I added a link to=20 > preserve the look. >=20 > >> +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(), ex= tra_sphinx_args], > >> + build_by_default: get_option('enable_docs'), > >> + install: get_option('enable_docs'), > >> + install_dir: htmldir) > >=20 > > When custom.css is copied? >=20 > I'm not sure what you're asking here. The call-sphinx-build.py copies it= =20 > during the build and it's also copied during the install phase. The file is copied in _static dir of sphinx guides. How does it work for DTS API? > >> +# Napoleon enables the Google format of Python doscstrings, used in D= TS. > >> +# Intersphinx allows linking to external projects, such as Python doc= s, also used in DTS. > >> +extensions =3D ['sphinx.ext.napoleon', 'sphinx.ext.intersphinx'] > >=20 > > What happens if napoleon and intersphinx are not available > > when building basic DPDK doc without DTS? >=20 > napoleon was added in version 1.3 and intersphinx in 0.5, so I didn't=20 > think of testing that. >=20 > 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=20 > 'sphinx.ext.foo') >=20 > I could add version checks for each of the extensions. My concern is to allow generating DPDK doc without DTS, without the new extra dependencies.