From mboxrd@z Thu Jan 1 00:00:00 1970 From: Luca Boccassi Subject: Re: [PATCH v3 4/4] build: generate API documentation with Meson Date: Mon, 10 Sep 2018 18:35:00 +0100 Message-ID: <1536600900.10952.5.camel@debian.org> References: <20180907165524.23982-1-bluca@debian.org> <20180910161306.12568-1-bluca@debian.org> <20180910161306.12568-4-bluca@debian.org> <20180910173051.GA26200@bricha3-MOBL.ger.corp.intel.com> Mime-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Cc: dev@dpdk.org, john.mcnamara@intel.com, marko.kovacevic@intel.com, thomas@monjalon.net To: Bruce Richardson Return-path: Received: from mail-wm0-f68.google.com (mail-wm0-f68.google.com [74.125.82.68]) by dpdk.org (Postfix) with ESMTP id 0DE2D4CC3 for ; Mon, 10 Sep 2018 19:35:03 +0200 (CEST) Received: by mail-wm0-f68.google.com with SMTP id y2-v6so22399447wma.1 for ; Mon, 10 Sep 2018 10:35:03 -0700 (PDT) In-Reply-To: <20180910173051.GA26200@bricha3-MOBL.ger.corp.intel.com> List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" On Mon, 2018-09-10 at 18:30 +0100, Bruce Richardson wrote: > On Mon, Sep 10, 2018 at 05:13:06PM +0100, Luca Boccassi wrote: > > Signed-off-by: Luca Boccassi > > --- > > v2: made doxygen dependency optional, skip doxygen build when not > > found > > v3: made doxygen dependency mandatory if enable_docs is true, add > > =C2=A0=C2=A0=C2=A0=C2=A0alternative doc target that prints "doxygen not= found" when > > doxygen > > =C2=A0=C2=A0=C2=A0=C2=A0is not found and enable_docs is false (default) > >=20 > > =C2=A0doc/api/generate_doxygen.sh | 10 +++++++ > > =C2=A0doc/api/meson.build=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2= =A0=C2=A0| 56 > > +++++++++++++++++++++++++++++++++++++ > > =C2=A0doc/build-sdk-meson.txt=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0|=C2=A0=C2= =A02 ++ > > =C2=A0doc/meson.build=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0= =C2=A0=C2=A0=C2=A0=C2=A0=C2=A0|=C2=A0=C2=A04 +++ > > =C2=A0meson.build=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0= =C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0|=C2=A0=C2=A03 ++ > > =C2=A0meson_options.txt=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0=C2=A0= =C2=A0=C2=A0=C2=A0|=C2=A0=C2=A02 ++ > > =C2=A06 files changed, 77 insertions(+) > > =C2=A0create mode 100755 doc/api/generate_doxygen.sh > > =C2=A0create mode 100644 doc/api/meson.build > > =C2=A0create mode 100644 doc/meson.build > >=20 > > diff --git a/doc/api/generate_doxygen.sh > > b/doc/api/generate_doxygen.sh > > new file mode 100755 > > index 0000000000..ab57660958 > > --- /dev/null > > +++ b/doc/api/generate_doxygen.sh > > @@ -0,0 +1,10 @@ > > +#! /bin/sh -e > > +# SPDX-License-Identifier: BSD-3-Clause > > +# Copyright 2018 Luca Boccassi > > + > > +DOXYCONF=3D$1 > > +OUTDIR=3D$2 > > +SCRIPTCSS=3D$3 > > + > > +doxygen "${DOXYCONF}" > > +"${SCRIPTCSS}" "${OUTDIR}"/doxygen.css > > diff --git a/doc/api/meson.build b/doc/api/meson.build > > new file mode 100644 > > index 0000000000..602fa7f3c3 > > --- /dev/null > > +++ b/doc/api/meson.build > > @@ -0,0 +1,56 @@ > > +# SPDX-License-Identifier: BSD-3-Clause > > +# Copyright(c) 2018 Luca Boccassi > > + > > +doxygen =3D find_program('doxygen', required: > > get_option('enable_docs')) > > + > > +if doxygen.found() > > + # due to the CSS customisation script, which needs to run > > on a file that > > + # is in a subdirectory that is created at build time and > > thus it cannot > > + # be an individual custom_target, we need to wrap the > > doxygen call in a > > + # script to run the CSS modification afterwards > > + generate_doxygen =3D find_program('generate_doxygen.sh') > > + generate_examples =3D find_program('generate_examples.sh') > > + generate_css =3D find_program('doxy-html-custom.sh') > > + > > + inputdir =3D join_paths(meson.source_root(), 'examples') > > + htmldir =3D join_paths('doc', 'html') > > + > > + # due to the following bug: https://github.com/mesonbuild/ > > meson/issues/4107 > > + # if install is set to true it will override > > build_by_default and it will > > + # cause the target to always be built. If install were to > > be always set to > > + # false it would be impossible to install the docs. > > + # So use a configure option for now. > > + example =3D custom_target('examples.dox', > > + input: inputdir, > > + output: 'examples.dox', > > + command: [generate_examples, '@INPUT@', '@OUTPUT@' > > ], > > + install: get_option('enable_docs'), > > + install_dir: htmldir, > > + build_by_default: false) > > + > > + cdata =3D configuration_data() > > + cdata.set('VERSION', meson.project_version()) > > + cdata.set('API_EXAMPLES', join_paths(meson.build_root(), > > 'doc', 'api', 'examples.dox')) > > + cdata.set('OUTPUT', join_paths(meson.build_root(), 'doc', > > 'api')) > > + cdata.set('HTML_OUTPUT', 'api') > > + cdata.set('TOPDIR', meson.source_root()) > > + cdata.set('STRIP_FROM_PATH', meson.source_root()) > > + > > + doxy_conf =3D configure_file(input: 'doxy-api.conf.in', > > + output: 'doxy-api.conf', > > + configuration: cdata, > > + install: false) > > + > > + doxy_build =3D custom_target('doxygen', > > + depends: example, > > + input: doxy_conf, > > + output: 'api', > > + command: [generate_doxygen, '@INPUT@', '@OUTPUT@', > > generate_css], > > + install: get_option('enable_docs'), > > + install_dir: htmldir, > > + build_by_default: false) > > + > > + run_target('doc', command: 'true', depends: doxy_build) > > +else > > + run_target('doc', command: ['echo', 'doxygen', 'not', > > 'found']) > > +endif >=20 > While I suggest we keep this in this patchset for now, this isn't > going to > scale as we add in more targets for building the PDF/HTML guides. I > think > for that case, we may need to use an array variable for the "depends" > target, and add things to that as we process the documentation > meson.build > files. That might work better for cases where we have some but not > all doc > build capabilities, e.g. missing sphinx but not doxygen. Yeah that makes sense, I can rework that once the sphinx stuff is also in. Did you manage to get it working yet? --=20 Kind regards, Luca Boccassi