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 DC49842B6F; Mon, 22 May 2023 11:17:55 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id AFE02410DD; Mon, 22 May 2023 11:17:55 +0200 (CEST) Received: from mail-ed1-f54.google.com (mail-ed1-f54.google.com [209.85.208.54]) by mails.dpdk.org (Postfix) with ESMTP id E719C410D1 for ; Mon, 22 May 2023 11:17:54 +0200 (CEST) Received: by mail-ed1-f54.google.com with SMTP id 4fb4d7f45d1cf-510f525e06cso6457613a12.2 for ; Mon, 22 May 2023 02:17:54 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=pantheon-tech.20221208.gappssmtp.com; s=20221208; t=1684747074; x=1687339074; h=content-transfer-encoding:cc:to:subject:message-id:date:from :in-reply-to:references:mime-version:from:to:cc:subject:date :message-id:reply-to; bh=2aEnmKDgnaXgh4AFmsm1ZbodrdrPOTJ/EPsMDHxavNM=; b=tMG2j2Gj1zy3YO1Y6OglFs14I2ghh8UN0aJcjODUSPOnzepABCKtQEb9HssUofPnhd 4Lfr7L/pE0AEM+d+3wfzqvNdouqmjUcIy6jwlD6eeKzbEV+nyTbBKzqDOYF3azU5MLtb F62iW9ZUxzI7OhpQ4x1N5Htn3ZHfcaNTu2vPsZ6H+kjU8uTqgciMw16TU8v5vVQy6678 HovseVmz3BR2nheywD6cflp+MLBNeGNuvvzPX6glP5QvU3tO5CWkoGbyGcopNaikhx7I UEbv6oDmXWMD0VwMQ1MoM7G93dORlrOme2obZuXQnPaYwvl48n8zjnXmUjzq8nueh1pX Y2cw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1684747074; x=1687339074; h=content-transfer-encoding:cc:to:subject:message-id:date:from :in-reply-to:references:mime-version:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=2aEnmKDgnaXgh4AFmsm1ZbodrdrPOTJ/EPsMDHxavNM=; b=JdWFKpzNKB+vB+MCRtRGk+avo9BGSudPYrXADjU24+42lBxxkq8pc/KxXQMe+ayibd I9ybxwr4kiXKVfWyIhVuD6t9h2yw3ghYeFAUjTuEx+TDrNMk7Yq1HCG67XR8ajFuKgdE bIe/DxRSlNbdaEjpk3ZiDOY8Ch6H9aVvxPZ9GMwp0FJrS3zwkinRDkp7/AQ4G8ZS+zzO JfGewsXNWQNtG86xUE6rofUl4h27CHDZARi5hY393XshcaUxnkK82NZC0lL5Md2kiujh rplCDDjODo9CP38XXAxAkPEeDMAvzytWGevg3HTxxQadC4QL/6c89ZuvqCRJRN8l3af8 an7Q== X-Gm-Message-State: AC+VfDxE4SMlVoqKlcsLPUmfSgbSmikTz2Zi7t7bNb3BdUY2+dbkF9w6 8v6PaOiLd/BrfZEAEa/7RbmZ4rakoy8kFQKMei87G88vqxMdlvUW X-Google-Smtp-Source: ACHHUZ6UtjR1kbHDfErB6USixQ/MxRhTRW+vV1ecMsKM+c3tEY9bUYH0hhMCpwksC9DuTTxiiyaVwP8k5Em5zbm7uYg= X-Received: by 2002:aa7:cd07:0:b0:4be:b39b:ea8f with SMTP id b7-20020aa7cd07000000b004beb39bea8fmr8539498edw.2.1684747074576; Mon, 22 May 2023 02:17:54 -0700 (PDT) MIME-Version: 1.0 References: <20230504123749.1417259-1-juraj.linkes@pantheon.tech> <20230511091408.236638-1-juraj.linkes@pantheon.tech> In-Reply-To: From: =?UTF-8?Q?Juraj_Linke=C5=A1?= Date: Mon, 22 May 2023 11:17:43 +0200 Message-ID: Subject: Re: [RFC PATCH v3 0/4] dts: add dts api docs To: Bruce Richardson Cc: thomas@monjalon.net, Honnappa.Nagarahalli@arm.com, lijuan.tu@intel.com, wathsala.vithanage@arm.com, jspewock@iol.unh.edu, probb@iol.unh.edu, dev@dpdk.org Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable 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 On Wed, May 17, 2023 at 6:57=E2=80=AFPM Bruce Richardson wrote: > > On Thu, May 11, 2023 at 11:14:04AM +0200, Juraj Linke=C5=A1 wrote: > > Augment the meson build system with dts api generation. The api docs ar= e > > generated from Python docstrings in DTS using Sphinx. The format of > > choice is the Google format [0]. > > > > The guides html sphinx configuration is used to preserve the same style= . > > > > The build requires the same Python version and dependencies as DTS, > > because Sphinx imports the Python modules. Dependencies are installed > > using Poetry from the dts directory: > > > > poetry install --with docs > > > > After installing, enter the Poetry shell: > > > > poetry shell > > > > And then run the build: > > ninja -C dts/doc > > > > There's only one properly documented module that serves as a > > demonstration of the style - framework.testbed_model.node. When we agre= e > > on the docstring format, all docstrings will be reformatted. > > > > [0] https://google.github.io/styleguide/pyguide.html#s3.8.4-comments-in= -classes > > > > Juraj Linke=C5=A1 (4): > > dts: code adjustments for sphinx > > dts: add doc generation dependencies > > dts: add doc generation > > dts: format docstrigs to google format > > > Given that building the DTS docs requires a special set of commands to se= t > things up and then to run the build through poetry, I think you should ju= st > drop the option in meson_options.txt. I think it's better if building the > DTS docs is the steps that out outline here, and we don't try and integra= te > it into the main DPDK build. > That makes a lot of sense. I'll make the change. > With that change: > > Series-acked-by: Bruce Richardson Thanks.