[PATCH 0/5] doc: Silence the sphinx build output
From: Simon Glass <simon.glass@canonical.com> The sphinx/htmldocs build is very noisy, making it hard to see warnings and errors. This series enables quiet mode for sphinx and removes various other progress messages, so that only warnings and errors are shown. Simon Glass (5): doc: Enable quiet mode for sphinx builds doc: Silence sub-make output in sphinx builds doc: Remove CJK informational message doc: Drop the SPHINX progress message doc: Drop the PARSE progress message doc/Makefile | 6 +++--- doc/conf.py | 1 - doc/media/Makefile | 3 +-- 3 files changed, 4 insertions(+), 6 deletions(-) -- 2.43.0 base-commit: b31d8c2479d5c3b9650b0694ef415150727fe380 branch: html
From: Simon Glass <simon.glass@canonical.com> The sphinx output is very noisy. Add -q to SPHINXOPTS so that only warnings and errors are shown. Co-developed-by: Claude Opus 4.5 <noreply@anthropic.com> Signed-off-by: Simon Glass <simon.glass@canonical.com> --- doc/Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/Makefile b/doc/Makefile index d0904a9f990..bdbbe09de9b 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -6,7 +6,7 @@ subdir-y := # You can set these variables from the command line. SPHINXBUILD = sphinx-build -SPHINXOPTS = -W +SPHINXOPTS = -q -W SPHINXDIRS = . _SPHINXDIRS = $(patsubst $(srctree)/doc/%/conf.py,%,$(wildcard $(srctree)/doc/*/conf.py)) SPHINX_CONF = conf.py -- 2.43.0
From: Simon Glass <simon.glass@canonical.com> Add -s to the sub-make invocation so that the "Nothing to be done" message is not shown. Co-developed-by: Claude Opus 4.5 <noreply@anthropic.com> Signed-off-by: Simon Glass <simon.glass@canonical.com> --- doc/Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/Makefile b/doc/Makefile index bdbbe09de9b..0b23b69f522 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -52,7 +52,7 @@ loop_cmd = $(echo-cmd) $(cmd_$(1)) || exit; # e.g. "media" for the linux-tv book-set at ./doc/media quiet_cmd_sphinx = SPHINX $@ --> file://$(abspath $(BUILDDIR)/$3/$4) - cmd_sphinx = $(MAKE) BUILDDIR=$(abspath $(BUILDDIR)) $(build)=doc/media $2 && \ + cmd_sphinx = $(MAKE) -s BUILDDIR=$(abspath $(BUILDDIR)) $(build)=doc/media $2 && \ PYTHONDONTWRITEBYTECODE=1 \ BUILDDIR=$(abspath $(BUILDDIR)) SPHINX_CONF=$(abspath $(srctree)/$(src)/$5/$(SPHINX_CONF)) \ $(SPHINXBUILD) \ -- 2.43.0
From: Simon Glass <simon.glass@canonical.com> The "enabling CJK for LaTeX builder" message adds noise to the build output. Remove the print statement since the functionality is still enabled. Co-developed-by: Claude Opus 4.5 <noreply@anthropic.com> Signed-off-by: Simon Glass <simon.glass@canonical.com> --- doc/conf.py | 1 - 1 file changed, 1 deletion(-) diff --git a/doc/conf.py b/doc/conf.py index c50daf874a5..348f0132ffc 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -377,7 +377,6 @@ latex_elements = { cjk_cmd = check_output(['fc-list', '--format="%{family[0]}\n"']).decode('utf-8', 'ignore') if cjk_cmd.find("Noto Sans CJK SC") >= 0: - print ("enabling CJK for LaTeX builder") latex_elements['preamble'] += ''' % This is needed for translations \\usepackage{xeCJK} -- 2.43.0
From: Simon Glass <simon.glass@canonical.com> This message is not needed since sphinx is now running in quiet mode. Co-developed-by: Claude Opus 4.5 <noreply@anthropic.com> Signed-off-by: Simon Glass <simon.glass@canonical.com> --- doc/Makefile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/Makefile b/doc/Makefile index 0b23b69f522..01bbbb95b41 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -51,7 +51,7 @@ loop_cmd = $(echo-cmd) $(cmd_$(1)) || exit; # $5 reST source folder relative to $(srctree)/$(src), # e.g. "media" for the linux-tv book-set at ./doc/media -quiet_cmd_sphinx = SPHINX $@ --> file://$(abspath $(BUILDDIR)/$3/$4) +quiet_cmd_sphinx = cmd_sphinx = $(MAKE) -s BUILDDIR=$(abspath $(BUILDDIR)) $(build)=doc/media $2 && \ PYTHONDONTWRITEBYTECODE=1 \ BUILDDIR=$(abspath $(BUILDDIR)) SPHINX_CONF=$(abspath $(srctree)/$(src)/$5/$(SPHINX_CONF)) \ -- 2.43.0
From: Simon Glass <simon.glass@canonical.com> This message is not needed since sphinx is now running in quiet mode. Co-developed-by: Claude Opus 4.5 <noreply@anthropic.com> Signed-off-by: Simon Glass <simon.glass@canonical.com> --- doc/media/Makefile | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/doc/media/Makefile b/doc/media/Makefile index 9b32258696b..f8178ff59ea 100644 --- a/doc/media/Makefile +++ b/doc/media/Makefile @@ -12,8 +12,7 @@ gen_rst = \ echo ${PARSER} $< $@ $(SRC_DIR)/$(notdir $@).exceptions; \ ${PARSER} $< $@ $(SRC_DIR)/$(notdir $@).exceptions -quiet_gen_rst = echo ' PARSE $(patsubst $(srctree)/%,%,$<)'; \ - ${PARSER} $< $@ $(SRC_DIR)/$(notdir $@).exceptions +quiet_gen_rst = ${PARSER} $< $@ $(SRC_DIR)/$(notdir $@).exceptions silent_gen_rst = ${gen_rst} -- 2.43.0
participants (1)
-
Simon Glass