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 1552742AA2; Tue, 9 May 2023 11:24:04 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 95786410FA; Tue, 9 May 2023 11:24:03 +0200 (CEST) Received: from mail-ej1-f49.google.com (mail-ej1-f49.google.com [209.85.218.49]) by mails.dpdk.org (Postfix) with ESMTP id 54281410D7 for ; Tue, 9 May 2023 11:24:02 +0200 (CEST) Received: by mail-ej1-f49.google.com with SMTP id a640c23a62f3a-959a3e2dd27so983338966b.3 for ; Tue, 09 May 2023 02:24:02 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=pantheon-tech.20221208.gappssmtp.com; s=20221208; t=1683624242; x=1686216242; 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=j/+P0iBCNzr2aOELFCwq2o2Lp1LWok9Q+DZsBq4KUWE=; b=puow+vOTdtjWgkXTO4GCzzS3bpo09O7K6+ok+u5NuhTRHRdg1nxVaaW0q2uNPpX2z5 KOFkTGo32b7vmR66/AujeBEc+4cPCBJR0FifDtlGRS1ZAXEgpmJ10friGZSpAAWrojZd skvN2NaclhxEin7ZOIIi3PhqOcCwOEMg1uHt4CrvFpOmw5bs2ak6bK/1v1TDa53RxPZQ 8+Of1VWxUvupFMDAVoE+4N5jTNPULr5Z9uSaFhHHnxaDyqrSecVNdB8ckS25resgCUQ9 2uVUMR0bTLPpRQIVhRMK2KoO0mtnEFSOCw+xR/541ulf5ypjNkXYYwl7FUBJLMQQiZ/p EYGw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1683624242; x=1686216242; 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=j/+P0iBCNzr2aOELFCwq2o2Lp1LWok9Q+DZsBq4KUWE=; b=f0rP4qFLrOKikB7/yIed63498NUJPfU59yjI0PNwN6ioBZJNEXkvgp37voGzBRuKDS RFjv0SibUHaM5GFkoNnxhJrBg9xvST7BITP5nat+r85R40R4NivkvA/DL5kbVQvgY15c 9kjhfIFSm25B1bOxezT/7FG9EwbZ2G/K9y7tvFaVhm9oOazclLD7YIJ4AKP5Yao1OsHc oaaUUSTbRqaeE/RJHfJcJO4rbIeb0HpyBtZU0aKrOyRqoXyKsvoiQfdFF0VbRFMOBojd nFc+9V4T8zhhMqkMRokeYGS1e5/uA4niQkylxlpngDCi6LRZug0j5yVsxPBDrwbZnG/d usgA== X-Gm-Message-State: AC+VfDyzvfM0MFlTtE8u93+sVBtlhmfwnYkNYq0lD7deH5mjoC0exZ3L 2Rz3qWm+XZCzwZmHq6xstNdRNo9EuTqlHBIOkq04WA== X-Google-Smtp-Source: ACHHUZ50ww15aVG2uGKSbzF+XhLDnWue3SAlBr8pRQdbW/2f249xm8U2g4RaU4j//dWRh9xvVUqmyzpsw6FJ4LYoyXo= X-Received: by 2002:a17:906:eeca:b0:953:83a4:a9ff with SMTP id wu10-20020a170906eeca00b0095383a4a9ffmr11331181ejb.49.1683624241743; Tue, 09 May 2023 02:24:01 -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: Tue, 9 May 2023 11:23:50 +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 3:29=E2=80=AFPM Bruce Richardson wrote: > > On Fri, May 05, 2023 at 01:13:34PM +0200, Juraj Linke=C5=A1 wrote: > > 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 alread= y > > > > used in DPDK. The configuration is kept the same to preserve the st= yle. > > > > > > > > Sphinx generates the documentation from Python docstrings. The docs= tring > > > > format most suitable for DTS seems to be the Google format [0] whic= h > > > > 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 t= he > > > > code. > > > > * Also the same Python packages as DTS, for the same reason. > > > > > > > > [0] https://google.github.io/styleguide/pyguide.html#38-comments-an= d-docstrings > > > > > > > > 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('enab= le_dts_docs')) > > > > +sphinx_apidoc =3D find_program('sphinx-apidoc', required: get_opti= on('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-inheritanc= e', > > > > > > 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_OPTIO= NS=3Dmembers,show-inheritance' not found or not executable > > > > > > A full log can be found at /home/bruce/dpdk.org/build-test/me= son-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' > > > > + > > I didn't try with 0.53.2 - let me test that, see if the error goes away. = We > may need different calls based on the meson version. > > Is there no other way to pass this data rather than via the environment? > Certainly. For background, I wanted to do the same thing we do for DPDK_VERSION, but that would require adding an additional parameter to call-sphinx-build.py, which wouldn't be used by the other call of call-sphinx-build.py (the one that builds doc guides), so I skipped the parameter and set the env var before the call. There are a few options that come to mind: 1. Use the parameter. There are two sub-options here, either make the parameter positional and mandatory and then we'd have an awkward call that builds the guides or I could make it optional, but that would make the script a bit more complex (some argparse logic would be needed). 2. Hard-code the path into conf.py. 3. Have separate conf.py files. Maybe we could make this work with symlinks= . There could be something else. I like adding the optional parameter. I don't know the policy on buildtools script complexity so let me know what you think. Juraj > /Bruce