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 E3A584575B; Wed, 7 Aug 2024 12:41:31 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 77D9340E39; Wed, 7 Aug 2024 12:41:31 +0200 (CEST) Received: from fhigh3-smtp.messagingengine.com (fhigh3-smtp.messagingengine.com [103.168.172.154]) by mails.dpdk.org (Postfix) with ESMTP id 9478640E19 for ; Wed, 7 Aug 2024 12:41:29 +0200 (CEST) Received: from compute4.internal (compute4.nyi.internal [10.202.2.44]) by mailfhigh.nyi.internal (Postfix) with ESMTP id F023011490B0; Wed, 7 Aug 2024 06:41:28 -0400 (EDT) Received: from mailfrontend1 ([10.202.2.162]) by compute4.internal (MEProxy); Wed, 07 Aug 2024 06:41:28 -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=1723027288; x=1723113688; bh=OSa68DLpWxGSBipjUmXHn4zZMAxVnfO8/dULQKETxg0=; b= era4+NG3h39y1LTNSqqYkm/Use+58XTCoVQfraJ1rTCoDPU9OBunHk4vvexydUuv XkZBDBZH1MeXRANe26RmvKj8PR5GwO3SZPay+O9TJgVPeeMXXr5ekmtRbm/SLDD0 51Zv44Px2EYMYshvRDLw4XmBDQzd98HdxT9QNRSULAbzUkWe1u3buzGN/0LZQoZq GjTe8VSGVk3NtzMd2pPb3780rwMoAae5wyEC1TRffN920mk1ZCojJTSebNMtZypZ FEs+rNu2uE3cyIxatfzZFSfPwrUGC69/+9WNd1VkuktyesDPFBN6fmykcL9g5+Xy njv2ji6OZhwKBxDCcPlWDg== 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=1723027288; x= 1723113688; bh=OSa68DLpWxGSBipjUmXHn4zZMAxVnfO8/dULQKETxg0=; b=t T6QX8Yf5zTb0gDuqQNOzunMA9c1UmP16DGJq3mQMP4ap+ReUH+eBCpCL0cDA61IR mB/ELb5pppIJZulSEMjX2sJHAfHCzMpHcNv+kFbpjKpACL8EMe5pFiSiq2CC7ou4 fU9hbnBF1BvuULv6R0TdKliWxGTBcVVrmce3YabThc64emzD498dfGMEublmxOmk O3+kEeYXiPHTay9pe1sk1HEfohEgb28UWMEo1BumwDHl5s+/jywYWjXTwQ0YTxoY Cm/eZY+bVBpIzsidpHEevPFL2RViFaffUNR612hcy9jq+QGD98UOWPNFl85mBmQK xgN4xCJ9yGYt7Nqxd0zXQ== X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeeftddrledtgdefudcutefuodetggdotefrodftvf curfhrohhfihhlvgemucfhrghsthforghilhdpqfgfvfdpuffrtefokffrpgfnqfghnecu uegrihhlohhuthemuceftddtnecusecvtfgvtghiphhivghnthhsucdlqddutddtmdenuc fjughrpefhvfevufffkfgjfhgggfgtsehtqhertddttdejnecuhfhrohhmpefvhhhomhgr shcuofhonhhjrghlohhnuceothhhohhmrghssehmohhnjhgrlhhonhdrnhgvtheqnecugg ftrfgrthhtvghrnhepgedttdeljeejgeffkeekkedtjeevtdehvedtkeeivdeuuedviedu vdelveejueejnecuvehluhhsthgvrhfuihiivgeptdenucfrrghrrghmpehmrghilhhfrh homhepthhhohhmrghssehmohhnjhgrlhhonhdrnhgvthdpnhgspghrtghpthhtoheptd X-ME-Proxy: Feedback-ID: i47234305:Fastmail Received: by mail.messagingengine.com (Postfix) with ESMTPA; Wed, 7 Aug 2024 06:41:27 -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 12:41:25 +0200 Message-ID: <2156393.OBFZWjSADL@thomas> In-Reply-To: <20240806151937.391917-6-juraj.linkes@pantheon.tech> References: <20231115133606.42081-1-juraj.linkes@pantheon.tech> <20240806151937.391917-1-juraj.linkes@pantheon.tech> <20240806151937.391917-6-juraj.linkes@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 06/08/2024 17:19, Juraj Linke=C5=A1: > +"""Utilities for DTS dependencies. > + > +The module can be used as an executable script, > +which verifies that the running Python version meets the version require= ment of DTS. > +The script returns the standard exit codes in this mode (0 is success, 1= is failure). Is it returning the list of dependencies for generating doc? > + > +The module also contains a function, get_missing_imports, > +which looks for runtime and doc generation dependencies in the DTS pypro= ject.toml file > +a returns a list of module names used in an import statement that are mi= ssing. typo? a -> and [...] > +get_dts_deps =3D py3 + files('get-dts-deps.py') deps for runtime or doc? may be good to specify in the name > --- /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? > +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? > +# Napoleon enables the Google format of Python doscstrings, used in DTS. > +# Intersphinx allows linking to external projects, such as Python docs, = 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?