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 3227142A70; Fri, 5 May 2023 13:13:47 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id B007A41144; Fri, 5 May 2023 13:13:46 +0200 (CEST) Received: from mail-ej1-f43.google.com (mail-ej1-f43.google.com [209.85.218.43]) by mails.dpdk.org (Postfix) with ESMTP id 35A8F410EA for ; Fri, 5 May 2023 13:13:46 +0200 (CEST) Received: by mail-ej1-f43.google.com with SMTP id a640c23a62f3a-94a34a14a54so317013166b.1 for ; Fri, 05 May 2023 04:13:46 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=pantheon-tech.20221208.gappssmtp.com; s=20221208; t=1683285226; x=1685877226; 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=GlPonL3MgW92foJjLvUAgIQMLh+sC3UHBIKinRVfEZE=; b=24yx65pweZlupYbL5GLWSR7uAtPpQQ3vi0ALLepQLcQ1VdIcNIi5I0vn1lCXdarvSt 8mueE/qZ2w8wwo2qH3Jk0njX/UBawSmVVbnwQRde2PegoEm53qYo86t2HROTRmp3saaf l2yU1+bsd0ZlijiWEROLtvwMlXgjI0gMKmoi+rb/tZJjmnI46lFgso5H307YfxQAV+VD B9xW8XDDz6lHjzcPD5kpT2hvZnJO7H/Q2O0a6L2R/IP/FL2LWHz3XpR58g/QenREBfYD ssfsg+79rL/3AGs/oBqItnl3fX7w9PpNdCEff8wuql8OHDmtTRNVFi437gE+6m0CP/EC SsrA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1683285226; x=1685877226; 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=GlPonL3MgW92foJjLvUAgIQMLh+sC3UHBIKinRVfEZE=; b=cJtbOddKczTV1XNgRu+Qcyb8wpefuG/c0LNxOkqMkmVunUC8n2HDuGUg/6G6eDQWnm ZlvBLESnOOrAyOOc43bIbqDhr5ILv5oG6nydeFjh1HW8kJ3ptkKN8rWqWCkRAYSMTFJe HWfDEJl5p6Asna8LjxsEWro1N1GHbigCahz2qUOGsguMl7bOYsOwfe3pGIzrskpEwgG0 83JF1ERh+1SPNzhtuPYQhlQWsWAsoJ8PBOYAdvIR19E0s7cxrCl5VAEyEuzSZ9Zo0mnK iLvpzDqYhNOoOdHoRoPd7UyQLazWTiPI5g+B98hTeGZZF9PcYmoAh56gkAI5j/4azFwn GBeA== X-Gm-Message-State: AC+VfDy5OR4k850vlMH/nfldCL9z+Biq+zLxQVOQPzna0MBASwgKc2fa kf7+J+E1IPkWUoQU9F6gF9a9sE4fLJjbLSEk+7mSMg== X-Google-Smtp-Source: ACHHUZ4ILquMF5ZCRr3L1S/jMJcIN+C/eWK0rFK/Hi+2hP9NpijX0Cn36GfUVOtY41VEB8GhsvsnXGE5jsXichnMldg= X-Received: by 2002:a17:907:5c6:b0:94e:e293:cf34 with SMTP id wg6-20020a17090705c600b0094ee293cf34mr810992ejb.6.1683285225808; Fri, 05 May 2023 04:13:45 -0700 (PDT) MIME-Version: 1.0 References: <20230323104040.484708-1-juraj.linkes@pantheon.tech> <20230504123749.1417259-1-juraj.linkes@pantheon.tech> <20230504123749.1417259-4-juraj.linkes@pantheon.tech> In-Reply-To: From: =?UTF-8?Q?Juraj_Linke=C5=A1?= Date: Fri, 5 May 2023 13:13:34 +0200 Message-ID: Subject: Re: [RFC PATCH v2 3/4] dts: add doc generation 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 Fri, May 5, 2023 at 12:57=E2=80=AFPM Bruce Richardson wrote: > > On Thu, May 04, 2023 at 02:37:48PM +0200, Juraj Linke=C5=A1 wrote: > > The tool used to generate developer docs is sphinx, which is already > > used in DPDK. The configuration is kept the same to preserve the style. > > > > Sphinx generates the documentation from Python docstrings. The docstrin= g > > format most suitable for DTS seems to be the Google format [0] which > > requires the sphinx.ext.napoleon extension. > > > > There are two requirements for building DTS docs: > > * The same Python version as DTS or higher, because Sphinx import the > > code. > > * Also the same Python packages as DTS, for the same reason. > > > > [0] https://google.github.io/styleguide/pyguide.html#38-comments-and-do= cstrings > > > > Signed-off-by: Juraj Linke=C5=A1 > > --- > > doc/api/meson.build | 1 + > > doc/guides/conf.py | 22 ++++++++++++++---- > > doc/guides/meson.build | 1 + > > doc/guides/tools/dts.rst | 29 +++++++++++++++++++++++ > > dts/doc/doc-index.rst | 20 ++++++++++++++++ > > dts/doc/meson.build | 50 ++++++++++++++++++++++++++++++++++++++++ > > dts/meson.build | 16 +++++++++++++ > > meson.build | 1 + > > meson_options.txt | 2 ++ > > 9 files changed, 137 insertions(+), 5 deletions(-) > > create mode 100644 dts/doc/doc-index.rst > > create mode 100644 dts/doc/meson.build > > create mode 100644 dts/meson.build > > > > > > diff --git a/dts/doc/meson.build b/dts/doc/meson.build > > new file mode 100644 > > index 0000000000..db2bb0bed9 > > --- /dev/null > > +++ b/dts/doc/meson.build > > @@ -0,0 +1,50 @@ > > +# SPDX-License-Identifier: BSD-3-Clause > > +# Copyright(c) 2023 PANTHEON.tech s.r.o. > > + > > +sphinx =3D find_program('sphinx-build', required: get_option('enable_d= ts_docs')) > > +sphinx_apidoc =3D find_program('sphinx-apidoc', required: get_option('= enable_dts_docs')) > > + > > +if sphinx.found() and sphinx_apidoc.found() > > +endif > > + > > +dts_api_framework_dir =3D join_paths(dts_dir, 'framework') > > +dts_api_build_dir =3D join_paths(doc_api_build_dir, 'dts') > > +dts_api_src =3D custom_target('dts_api_src', > > + output: 'modules.rst', > > + command: ['SPHINX_APIDOC_OPTIONS=3Dmembers,show-inheritance', > > This gives errors when I try to configure a build, even without docs > enabled. > > ~/dpdk.org$ meson setup build-test > The Meson build system > Version: 1.0.1 > Source dir: /home/bruce/dpdk.org > ... > Program sphinx-build found: YES (/usr/bin/sphinx-build) > Program sphinx-build found: YES (/usr/bin/sphinx-build) > Program sphinx-apidoc found: YES (/usr/bin/sphinx-apidoc) > > dts/doc/meson.build:12:0: ERROR: Program 'SPHINX_APIDOC_OPTIONS= =3Dmembers,show-inheritance' not found or not executable > > A full log can be found at /home/bruce/dpdk.org/build-test/meson-= logs/meson-log.txt > > Assuming these need to be set in the environment, I think you can use the > "env" parameter to custom target instead. > I used meson 0.53.2 as that seemed to be the version I should target (it's used in .ci/linux-setup.sh) which doesn't support the argument (I originally wanted to use it, but they added it in 0.57.0). I didn't see the error with 0.53.2. Which version should I target? 1.0.1? > > + sphinx_apidoc, '--append-syspath', '--force', > > + '--module-first', '--separate', > > + '--doc-project', 'DTS', '-V', meson.project_version(), > > + '-o', dts_api_build_dir, > > + dts_api_framework_dir], > > + build_by_default: get_option('enable_dts_docs')) > > +doc_targets +=3D dts_api_src > > +doc_target_names +=3D 'DTS_API_sphinx_sources' > > +