From cf07e89d0665fc06911946c188105ac12e5404fd Mon Sep 17 00:00:00 2001 From: Erik Faye-Lund Date: Thu, 2 Jan 2025 11:54:44 +0100 Subject: [PATCH] docs/ci: treat warnings as errors When we moved building the docs to Meson, we accidentally dropped the -W flag that we used to have. This lead to us no longer detecting certain problems in the docs, which is unfortunate. Let's bring this back gated by the werror meson-option, and wire that up on the CI end. Fixes: fdd204538b9 ("ci: build docs using meson") Reviewed-by: Dylan Baker Part-of: --- docs/gitlab-ci.yml | 1 + docs/meson.build | 6 ++++++ 2 files changed, 7 insertions(+) diff --git a/docs/gitlab-ci.yml b/docs/gitlab-ci.yml index e052b893f48..54910af6ccb 100644 --- a/docs/gitlab-ci.yml +++ b/docs/gitlab-ci.yml @@ -10,6 +10,7 @@ - meson setup _build -D prefix=$(pwd) --auto-features=disabled -D vulkan-drivers="" -D gallium-drivers="" -D platforms=[] -D glx=disabled -D video-codecs="" -D html-docs=enabled -D html-docs-path=public + -D werror=true - meson compile -C _build - meson install -C _build diff --git a/docs/meson.build b/docs/meson.build index eb33509503d..dc8fd6979fa 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -11,12 +11,18 @@ assert Version(hawkmoth.__version__) >= Version("0.16.0") error_message: 'hawkmoth >= 0.16.0 required' ) +sphinx_args = [] +if get_option('werror') + sphinx_args += '-W' +endif + html_docs = custom_target( 'html', depfile: 'docs.d', depend_files: files('conf.py'), command: [sphinx, '-b', 'html', '-q', '-Ddepfile=@DEPFILE@', + sphinx_args, meson.current_source_dir(), '@OUTPUT@'], output: 'html', build_by_default: get_option('html-docs').enabled(),