numam-dpdk/doc/guides/meson.build
Bruce Richardson 6572fc9260 doc: make sphinx comply with meson werror option
When the --werror meson build option is set, we can pass the "-W",
warning-as-errors, flag to sphinx to get the same behaviour for doc
building as for building the rest of DPDK. This can help catch
documentation errors sooner in the development process.

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
2020-10-05 23:52:02 +02:00

32 lines
844 B
Meson

# SPDX-License-Identifier: BSD-3-Clause
# Copyright(c) 2018 Intel Corporation
sphinx = find_program('sphinx-build', required: get_option('enable_docs'))
if not sphinx.found()
subdir_done()
endif
extra_sphinx_args = []
if get_option('werror')
extra_sphinx_args += '-W'
endif
htmldir = join_paths(get_option('datadir'), 'doc', 'dpdk')
html_guides = custom_target('html_guides',
input: files('index.rst'),
output: 'html',
command: [sphinx_wrapper, sphinx, meson.project_version(),
meson.current_source_dir(), meson.current_build_dir(),
extra_sphinx_args],
depfile: '.html.d',
build_by_default: get_option('enable_docs'),
install: get_option('enable_docs'),
install_dir: htmldir)
install_data(files('custom.css'),
install_dir: join_paths(htmldir,'_static', 'css'))
doc_targets += html_guides
doc_target_names += 'HTML_Guides'