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 BE3CE454E2; Mon, 24 Jun 2024 16:25:44 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id B1BF14060C; Mon, 24 Jun 2024 16:25:44 +0200 (CEST) Received: from fout3-smtp.messagingengine.com (fout3-smtp.messagingengine.com [103.168.172.146]) by mails.dpdk.org (Postfix) with ESMTP id E3511402F0 for ; Mon, 24 Jun 2024 16:25:26 +0200 (CEST) Received: from compute4.internal (compute4.nyi.internal [10.202.2.44]) by mailfout.nyi.internal (Postfix) with ESMTP id 6643E13800D7; Mon, 24 Jun 2024 10:25:26 -0400 (EDT) Received: from mailfrontend2 ([10.202.2.163]) by compute4.internal (MEProxy); Mon, 24 Jun 2024 10:25:26 -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=fm2; t=1719239126; x=1719325526; bh=824Py2v9qBKY8e+/rXQSfIJXmvtI/ziE4QpY+BTr0YQ=; b= SYCb9YjKuGYLnjEvXnfxGebVyxmltm2fIJfyxIxaTWYC7tkdsDfX1sdpkQQ7GHGr ntTq/vN2e+oFLAsgH4cJkj/tNzGK19yXjko7VFpQ7pqFxKdNTduJ2Ju9RO7MdLZt x/ZZNfJ7WeIgdrgruUX0zGXsjXxWYyLF3/HNjmZPIC1p21T+UhzPGzcAjSLejQQb gKLWqeDbaGl1jQpiBrj5RIOYwuDQtXZVtn5+zIwyw9vVdaDrxquBv0BexaXjoPGt 7U+ABKK0HdD7DcDiPO83cwblF+noUPu5W66qtgXF9ZhSA1BLJJuyBqpHhqzOHC0Q 3ltey+QsIYR1/nid7ugYwA== 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=fm2; t=1719239126; x= 1719325526; bh=824Py2v9qBKY8e+/rXQSfIJXmvtI/ziE4QpY+BTr0YQ=; b=S EGwSCB60IWmGVa6Wgf2UYqr2MFuRLLT2/8r2ZCCoZvzBBym8VRxRyXIJ7Dc4yr/T 7pqiGAvs2Zij2xi8y9yyh52cC09uGGC9/EltldddMyGidF1uuTc3eO66hemxynE6 rotDeET7JjwqvtyDKRiNn1KaPMEf+zWzLQH8mVODz6hTvIt+0apsV0HHeZYM8zcq h+Sna7miAeigVss7HzvB/0W7WuEYS8z5gmLpLcltXG9rQKxCK1y1qymA2RP3Ln2j Cx3L9cr5v6BSoabY4FlC4Yfl5738k9z7Ca2veqlOA8JyT5jbOpRwhxiKGddgfD/j 3aoC3lcgfgJblB79MUo0w== X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvledrfeeguddgjeejucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucesvcftvggtihhpihgvnhhtshculddquddttddmne goufhushhpvggtthffohhmrghinhculdegledmnecujfgurhephffvvefufffkjghfggfg tgesthhqredttddtjeenucfhrhhomhepvfhhohhmrghsucfoohhnjhgrlhhonhcuoehthh homhgrshesmhhonhhjrghlohhnrdhnvghtqeenucggtffrrghtthgvrhhnpeffueffkeef geekffehledvtdfhffetjeffledvtefgtdegleehkefgkeekudffkeenucffohhmrghinh epghhithhhuhgsrdhiohdptghonhhfrdhinhenucevlhhushhtvghrufhiiigvpedtnecu rfgrrhgrmhepmhgrihhlfhhrohhmpehthhhomhgrshesmhhonhhjrghlohhnrdhnvght X-ME-Proxy: Feedback-ID: i47234305:Fastmail Received: by mail.messagingengine.com (Postfix) with ESMTPA; Mon, 24 Jun 2024 10:25:24 -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, Luca Vizzarro Subject: Re: [PATCH v6 4/4] dts: add API doc generation Date: Mon, 24 Jun 2024 16:25:21 +0200 Message-ID: <3078072.VqyquhjGfd@thomas> In-Reply-To: <20240624134600.31500-5-juraj.linkes@pantheon.tech> References: <20231115133606.42081-1-juraj.linkes@pantheon.tech> <20240624134600.31500-1-juraj.linkes@pantheon.tech> <20240624134600.31500-5-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 24/06/2024 15:46, Juraj Linke=C5=A1: > The tool used to generate DTS API docs is Sphinx, which is already in > use in DPDK. The same configuration is used to preserve style with one > DTS-specific configuration (so that the DPDK docs are unchanged) that > modifies how the sidebar displays the content. >=20 > Sphinx generates the documentation from Python docstrings. The docstring > format is the Google format [0] which requires the sphinx.ext.napoleon > extension. The other extension, sphinx.ext.intersphinx, enables linking > to object in external documentations, such as the Python documentation. >=20 > There are two requirements for building DTS docs: > * The same Python version as DTS or higher, because Sphinx imports the > code. > * Also the same Python packages as DTS, for the same reason. >=20 > [0] https://google.github.io/styleguide/pyguide.html#38-comments-and-docs= trings >=20 > Signed-off-by: Juraj Linke=C5=A1 > Reviewed-by: Luca Vizzarro > Reviewed-by: Jeremy Spewock > Tested-by: Luca Vizzarro > Tested-by: Nicholas Pratte > --- > buildtools/call-sphinx-build.py | 31 ++++++++++++++++++-------- > doc/api/doxy-api-index.md | 3 +++ > doc/api/doxy-api.conf.in | 2 ++ > doc/api/meson.build | 11 +++++++--- > doc/guides/conf.py | 39 ++++++++++++++++++++++++++++----- > doc/guides/meson.build | 1 + > doc/guides/tools/dts.rst | 34 +++++++++++++++++++++++++++- > dts/doc/meson.build | 27 +++++++++++++++++++++++ > dts/meson.build | 16 ++++++++++++++ > meson.build | 1 + > 10 files changed, 147 insertions(+), 18 deletions(-) > create mode 100644 dts/doc/meson.build > create mode 100644 dts/meson.build There are unrelated changes in this patch. Please I would prefer to have existing code changed in a separate patch, so we have only DTS addition in the last patch.