From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-wr1-f65.google.com (mail-wr1-f65.google.com [209.85.221.65]) by dpdk.org (Postfix) with ESMTP id 0635B262E for ; Thu, 20 Sep 2018 15:22:27 +0200 (CEST) Received: by mail-wr1-f65.google.com with SMTP id y8-v6so5734606wrh.7 for ; Thu, 20 Sep 2018 06:22:27 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=VxAmY4J8HeKlgPtJxXAjtRESxs3DdEyi7TuHaAlT63c=; b=bncO/VaXLIJrxzyaRtdYUehPC1Ahp1/yHbcNN0goPAHomMj+HsUZ3g+Wv0hSH4+oln +3aCFqgqukOhS7cdC9iZ8k+Jl1oK43XyUYdM41ZRBgO7LHL1L3feKOHNF1FVCeKO2Iyn MW79kwNIYhxod/3A/ss3asC+LEp9Wlojz8oCY4JfFca9587Advaspei1UF5HMJ79ea1g v/gM8ly1foM2qlpBq2cY4EmbnB93GWgBAd1LB8Gv1gghB9CltvHi0BPSk3Mk0jXUguAm jturmC9sBbouf8zuou2DSx0wihOoSBZc8qgbDU+tNYPNy+lCh8s3AIQ8aXE/+REItYYt G1vg== X-Gm-Message-State: APzg51CiU3FOiCEfKOR5vM7jUO4K74mXRa2m6BMCZDAAvaXjDxYo1vm7 5YMd+6sLxherhZUVX2VXwR/9H8xW X-Google-Smtp-Source: ANB0VdYXt5YXHxW8TsdG1YZxDvpErfGBwxq/XaXvyZdZC2PUUv248Rx/mWmTQUrEGVFnlOMsbGUFyw== X-Received: by 2002:adf:f608:: with SMTP id t8-v6mr33230314wrp.186.1537449747160; Thu, 20 Sep 2018 06:22:27 -0700 (PDT) Received: from localhost ([2001:1be0:110d:fcfe:489f:80a9:5d59:c6bd]) by smtp.gmail.com with ESMTPSA id b74-v6sm3601671wma.8.2018.09.20.06.22.25 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Thu, 20 Sep 2018 06:22:25 -0700 (PDT) From: Luca Boccassi To: dev@dpdk.org Cc: bruce.richardson@intel.com, tredaelli@redhat.com, Luca Boccassi Date: Thu, 20 Sep 2018 14:22:08 +0100 Message-Id: <20180920132208.14583-1-bluca@debian.org> X-Mailer: git-send-email 2.18.0 In-Reply-To: <20180911161322.20114-1-bruce.richardson@intel.com> References: <20180911161322.20114-1-bruce.richardson@intel.com> Subject: [dpdk-dev] [PATCH v3] doc: support building HTML guides with meson X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 20 Sep 2018 13:22:28 -0000 From: Bruce Richardson Signed-off-by: Bruce Richardson Signed-off-by: Luca Boccassi --- v2: send on behalf of Bruce on request. - tell sphinx to create .doctrees working files in the parent of the target directory so that they don't get installed - change the output directory so that it matches the legacy makefiles directory structure (on install) - add install_dir to fix ninja install - add post-install calls to delete .buildinfo sphinx temporary file and to install custom.css as the makefiles do The installed directory has been verified to be bit-by-bit identical to the legacy makefiles with diffoscope. v3: re-arranged sphinx parameters to make it work on older versions (RHEL 7), and specify DEST filename on the install call, to make it work on older version (RHEL 7) doc/api/meson.build | 5 ++--- doc/guides/meson.build | 28 ++++++++++++++++++++++++++++ doc/meson.build | 11 +++++++++++ 3 files changed, 41 insertions(+), 3 deletions(-) create mode 100644 doc/guides/meson.build diff --git a/doc/api/meson.build b/doc/api/meson.build index 13fcbb8cd7..30bdc573b5 100644 --- a/doc/api/meson.build +++ b/doc/api/meson.build @@ -50,7 +50,6 @@ if doxygen.found() install_dir: htmldir, build_by_default: false) - run_target('doc', command: 'true', depends: doxy_build) -else - run_target('doc', command: ['echo', 'doxygen', 'not', 'found']) + doc_targets += doxy_build + doc_target_names += 'Doxygen_API' endif diff --git a/doc/guides/meson.build b/doc/guides/meson.build new file mode 100644 index 0000000000..06f14882bb --- /dev/null +++ b/doc/guides/meson.build @@ -0,0 +1,28 @@ +# SPDX-License-Identifier: BSD-3-Clause +# Copyright(c) 2018 Intel Corporation + +sphinx = find_program('sphinx-build', required: get_option('enable_docs')) + +if sphinx.found() + htmldir = join_paths('share', 'doc', 'dpdk') + html_guides_build = custom_target('html_guides_build', + input: meson.current_source_dir(), + output: 'guides', + command: [sphinx, '-b', 'html', + '-d', meson.current_build_dir() + '/.doctrees', + '@INPUT@', meson.current_build_dir() + '/guides'], + build_by_default: false, + install: get_option('enable_docs'), + install_dir: htmldir) + + doc_targets += html_guides_build + doc_target_names += 'HTML_Guides' + + # sphinx leaves a .buildinfo in the target directory, which we don't + # want to install. Note that sh -c has to be used, otherwise the + # env var does not get expanded if calling rm/install directly. + meson.add_install_script('sh', '-c', + 'rm -f $MESON_INSTALL_DESTDIR_PREFIX/share/doc/dpdk/guides/.buildinfo') + meson.add_install_script('sh', '-c', + 'install -D -m0644 $MESON_SOURCE_ROOT/doc/guides/custom.css $MESON_INSTALL_DESTDIR_PREFIX/share/doc/dpdk/guides/_static/css/custom.css') +endif diff --git a/doc/meson.build b/doc/meson.build index afca2e7133..c5410d85d6 100644 --- a/doc/meson.build +++ b/doc/meson.build @@ -1,4 +1,15 @@ # SPDX-License-Identifier: BSD-3-Clause # Copyright(c) 2018 Luca Boccassi +doc_targets = [] +doc_target_names = [] subdir('api') +subdir('guides') + +if doc_targets.length() == 0 + message = 'No docs targets found' +else + message = 'Building docs:' +endif +run_target('doc', command: ['echo', message, doc_target_names], + depends: doc_targets) -- 2.18.0