Fix GitHub log verbosity by samsrabin · Pull Request #61 · ESMCI/doc-builder

samsrabin · 2026-06-25T17:54:41Z

No description provided.

* Add reStructuredText version * Fix formatting in both

github-actions · 2026-06-25T17:58:43Z

❌ Docs build failed

Build logs

Running: make fetch-images
git lfs install --force
Updated Git hooks.
Git LFS initialized.
git lfs pull --exclude="" --include=""
Running: ./tools/build_docs.py -b /home/runner/work/doc-builder/doc-builder/_build -c -d --verbose
options: Namespace(build_dir='/home/runner/work/doc-builder/doc-builder/_build', repo_root=None, site_root=None, build_in_container=True, container_cli_tool=None, conf_py_path='conf.py', static_path='_static', templates_path='_templates', verbose=True, doc_version=[None], version_display_name=None, clean=True, container_image=None, build_target='html', num_make_jobs=4, versions=False, warnings_as_warnings=False)
docker run --name build_docs_cyhulpkt --user 1001:1001 --mount type=bind,source=/home/runner/work/doc-builder/doc-builder,target=/home/user/mounted_home --workdir /home/user/mounted_home/. -t --rm -e current_version=None ghcr.io/esmci/doc-builder/doc-build-container:v2.0.1a make SPHINXOPTS=-W --keep-going BUILDDIR=/home/user/mounted_home/_build -e version_display_name=None -e html_static_path=_static -e templates_path=_templates -e version_dropdown= -j 4 clean
Done.
docker run --name build_docs_cyhulpkt --user 1001:1001 --mount type=bind,source=/home/runner/work/doc-builder/doc-builder,target=/home/user/mounted_home --workdir /home/user/mounted_home/. -t --rm -e current_version=None ghcr.io/esmci/doc-builder/doc-build-container:v2.0.1a make SPHINXOPTS=-W --keep-going -c '' BUILDDIR=/home/user/mounted_home/_build -e version_display_name=None -e html_static_path=_static -e templates_path=_templates -e version_dropdown= -j 4 html
sphinx-build -M html "source" "/home/user/mounted_home/_build" -c "." -W --keep-going -c '' 
Running Sphinx v8.2.3
loading translations [en]... done
making output directory... done
Converting `source_suffix = ['.rst', '.md']` to `source_suffix = {'.rst': 'restructuredtext', '.md': 'restructuredtext'}`.
loading intersphinx inventory 'python' from https://docs.python.org/objects.inv ...
intersphinx inventory has moved: https://docs.python.org/objects.inv -> https://docs.python.org/3/objects.inv
myst v5.0.0: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions={'substitution', 'dollarmath'}, disable_syntax=[], all_links_external=False, links_external_new_tab=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, fence_as_directive=set(), number_code_blocks=[], title_to_header=False, heading_anchors=0, heading_slug_func=None, html_meta={}, footnote_sort=True, footnote_transition=True, words_per_minute=200, substitutions={project: ..., copyright: ..., author: ..., version: ..., release: ..., version_label: ..., tex_category: ..., nonparamfile_disclaimer_md: ..., nonparamfile_disclaimer_rst: ...}, linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True, dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True, mathjax_classes='tex2jax_process|mathjax_process|math|output_area', enable_checkboxes=False, suppress_warnings=[], highlight_code_blocks=True)
building [mo]: targets for 0 po files that are out of date
writing output... 
building [html]: targets for 3 source files that are out of date
updating environment: [new config] 3 added, 0 changed, 0 removed
reading sources... [ 33%] index
reading sources... [ 67%] markdown
reading sources... [100%] reStructuredText

/home/user/mounted_home/source/reStructuredText.rst:1: CRITICAL: Title overline & underline mismatch.

***********************
Info (reStructuredText)
******************* [docutils]
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
copying assets... 
copying static files... 
Writing evaluated template result to /home/user/mounted_home/_build/html/_static/documentation_options.js
Writing evaluated template result to /home/user/mounted_home/_build/html/_static/language_data.js
Writing evaluated template result to /home/user/mounted_home/_build/html/_static/basic.css
Writing evaluated template result to /home/user/mounted_home/_build/html/_static/js/versions.js
copying static files: done
copying extra files... 
copying extra files: done
copying assets: done
writing output... [ 33%] index
writing output... [ 67%] markdown
writing output... [100%] reStructuredText

/home/user/mounted_home/source/index.md:3: WARNING: toctree contains reference to document 'reStructuredText' that doesn't have a title: no link will be generated [toc.no_title]
/home/user/mounted_home/source/index.md:3: WARNING: toctree contains reference to document 'reStructuredText' that doesn't have a title: no link will be generated [toc.no_title]
/home/user/mounted_home/source/index.md:3: WARNING: toctree contains reference to document 'reStructuredText' that doesn't have a title: no link will be generated [toc.no_title]
/home/user/mounted_home/source/index.md:3: WARNING: toctree contains reference to document 'reStructuredText' that doesn't have a title: no link will be generated [toc.no_title]
generating indices... genindex /home/user/mounted_home/source/index.md:3: WARNING: toctree contains reference to document 'reStructuredText' that doesn't have a title: no link will be generated [toc.no_title]
done
writing additional pages... search /home/user/mounted_home/source/index.md:3: WARNING: toctree contains reference to document 'reStructuredText' that doesn't have a title: no link will be generated [toc.no_title]
done
dumping search index in English (code: en)... done
dumping object inventory... done
build finished with problems, 7 warnings (with warnings treated as errors).
make: *** [Makefile:41: html] Error 1
WARNING: The requested image's platform (linux/amd64/v8) does not match the detected host platform (linux/amd64/v3) and no specific platform was requested
Traceback (most recent call last):
  File "/home/runner/work/doc-builder/doc-builder/./tools/build_docs.py", line 19, in <module>
    build_docs.main()
  File "/home/runner/work/doc-builder/doc-builder/./tools/../doc_builder/build_docs.py", line 437, in main
    run_build_command(build_command=build_command, version=version, options=opts)
  File "/home/runner/work/doc-builder/doc-builder/./tools/../doc_builder/build_docs.py", line 298, in run_build_command
    result = _try_build_command(build_command, verbose, env)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/runner/work/doc-builder/doc-builder/./tools/../doc_builder/build_docs.py", line 315, in _try_build_command
    result = subprocess.run(build_command, env=env, check=True, capture_output=True)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/subprocess.py", line 571, in run
    raise CalledProcessError(retcode, process.args,
subprocess.CalledProcessError: Command '['docker', 'run', '--name', 'build_docs_cyhulpkt', '--user', '1001:1001', '--mount', 'type=bind,source=/home/runner/work/doc-builder/doc-builder,target=/home/user/mounted_home', '--workdir', '/home/user/mounted_home/.', '-t', '--rm', '-e', 'current_version=None', 'ghcr.io/esmci/doc-builder/doc-build-container:v2.0.1a', 'make', "SPHINXOPTS=-W --keep-going -c ''", 'BUILDDIR=/home/user/mounted_home/_build', '-e', 'version_display_name=None', '-e', 'html_static_path=_static', '-e', 'templates_path=_templates', '-e', 'version_dropdown=', '-j', '4', 'html']' returned non-zero exit status 2.

github-actions · 2026-06-25T18:01:14Z

❌ Docs build failed

Build logs

Running: make fetch-images
git lfs install --force
Updated Git hooks.
Git LFS initialized.
git lfs pull --exclude="" --include=""
Running: ./tools/build_docs.py -b /home/runner/work/doc-builder/doc-builder/_build -c -d --verbose
options: Namespace(build_dir='/home/runner/work/doc-builder/doc-builder/_build', repo_root=None, site_root=None, build_in_container=True, container_cli_tool=None, conf_py_path='conf.py', static_path='_static', templates_path='_templates', verbose=True, doc_version=[None], version_display_name=None, clean=True, container_image=None, build_target='html', num_make_jobs=4, versions=False, warnings_as_warnings=False)
docker run --name build_docs_nyyntqwk --user 1001:1001 --mount type=bind,source=/home/runner/work/doc-builder/doc-builder,target=/home/user/mounted_home --workdir /home/user/mounted_home/. -t --rm -e current_version=None ghcr.io/esmci/doc-builder/doc-build-container:v2.0.1a make SPHINXOPTS=-W --keep-going BUILDDIR=/home/user/mounted_home/_build -e version_display_name=None -e html_static_path=_static -e templates_path=_templates -e version_dropdown= -j 4 clean
Done.
docker run --name build_docs_nyyntqwk --user 1001:1001 --mount type=bind,source=/home/runner/work/doc-builder/doc-builder,target=/home/user/mounted_home --workdir /home/user/mounted_home/. -t --rm -e current_version=None ghcr.io/esmci/doc-builder/doc-build-container:v2.0.1a make SPHINXOPTS=-W --keep-going -c '' BUILDDIR=/home/user/mounted_home/_build -e version_display_name=None -e html_static_path=_static -e templates_path=_templates -e version_dropdown= -j 4 html
sphinx-build -M html "source" "/home/user/mounted_home/_build" -c "." -W --keep-going -c '' 
Running Sphinx v8.2.3
loading translations [en]... done
making output directory... done
Converting `source_suffix = ['.rst', '.md']` to `source_suffix = {'.rst': 'restructuredtext', '.md': 'restructuredtext'}`.
loading intersphinx inventory 'python' from https://docs.python.org/objects.inv ...
intersphinx inventory has moved: https://docs.python.org/objects.inv -> https://docs.python.org/3/objects.inv
myst v5.0.0: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions={'substitution', 'dollarmath'}, disable_syntax=[], all_links_external=False, links_external_new_tab=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, fence_as_directive=set(), number_code_blocks=[], title_to_header=False, heading_anchors=0, heading_slug_func=None, html_meta={}, footnote_sort=True, footnote_transition=True, words_per_minute=200, substitutions={project: ..., copyright: ..., author: ..., version: ..., release: ..., version_label: ..., tex_category: ..., nonparamfile_disclaimer_md: ..., nonparamfile_disclaimer_rst: ...}, linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True, dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True, mathjax_classes='tex2jax_process|mathjax_process|math|output_area', enable_checkboxes=False, suppress_warnings=[], highlight_code_blocks=True)
building [mo]: targets for 0 po files that are out of date
writing output... 
building [html]: targets for 3 source files that are out of date
updating environment: [new config] 3 added, 0 changed, 0 removed
reading sources... [ 33%] index
reading sources... [ 67%] markdown
reading sources... [100%] reStructuredText

/home/user/mounted_home/source/reStructuredText.rst:1: CRITICAL: Title overline & underline mismatch.

***********************
Info (reStructuredText)
******************* [docutils]
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
copying assets... 
copying static files... 
Writing evaluated template result to /home/user/mounted_home/_build/html/_static/documentation_options.js
Writing evaluated template result to /home/user/mounted_home/_build/html/_static/language_data.js
Writing evaluated template result to /home/user/mounted_home/_build/html/_static/basic.css
Writing evaluated template result to /home/user/mounted_home/_build/html/_static/js/versions.js
copying static files: done
copying extra files... 
copying extra files: done
copying assets: done
writing output... [ 33%] index
writing output... [ 67%] markdown
writing output... [100%] reStructuredText

/home/user/mounted_home/source/index.md:3: WARNING: toctree contains reference to document 'reStructuredText' that doesn't have a title: no link will be generated [toc.no_title]
/home/user/mounted_home/source/index.md:3: WARNING: toctree contains reference to document 'reStructuredText' that doesn't have a title: no link will be generated [toc.no_title]
/home/user/mounted_home/source/index.md:3: WARNING: toctree contains reference to document 'reStructuredText' that doesn't have a title: no link will be generated [toc.no_title]
/home/user/mounted_home/source/index.md:3: WARNING: toctree contains reference to document 'reStructuredText' that doesn't have a title: no link will be generated [toc.no_title]
generating indices... genindex /home/user/mounted_home/source/index.md:3: WARNING: toctree contains reference to document 'reStructuredText' that doesn't have a title: no link will be generated [toc.no_title]
done
writing additional pages... search /home/user/mounted_home/source/index.md:3: WARNING: toctree contains reference to document 'reStructuredText' that doesn't have a title: no link will be generated [toc.no_title]
done
dumping search index in English (code: en)... done
dumping object inventory... done
build finished with problems, 7 warnings (with warnings treated as errors).
make: *** [Makefile:41: html] Error 1
WARNING: The requested image's platform (linux/amd64/v8) does not match the detected host platform (linux/amd64/v3) and no specific platform was requested
Traceback (most recent call last):
  File "/home/runner/work/doc-builder/doc-builder/./tools/build_docs.py", line 19, in <module>
    build_docs.main()
  File "/home/runner/work/doc-builder/doc-builder/./tools/../doc_builder/build_docs.py", line 437, in main
    run_build_command(build_command=build_command, version=version, options=opts)
  File "/home/runner/work/doc-builder/doc-builder/./tools/../doc_builder/build_docs.py", line 298, in run_build_command
    result = _try_build_command(build_command, verbose, env)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/runner/work/doc-builder/doc-builder/./tools/../doc_builder/build_docs.py", line 315, in _try_build_command
    result = subprocess.run(build_command, env=env, check=True, capture_output=True)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/lib/python3.12/subprocess.py", line 571, in run
    raise CalledProcessError(retcode, process.args,
subprocess.CalledProcessError: Command '['docker', 'run', '--name', 'build_docs_nyyntqwk', '--user', '1001:1001', '--mount', 'type=bind,source=/home/runner/work/doc-builder/doc-builder,target=/home/user/mounted_home', '--workdir', '/home/user/mounted_home/.', '-t', '--rm', '-e', 'current_version=None', 'ghcr.io/esmci/doc-builder/doc-build-container:v2.0.1a', 'make', "SPHINXOPTS=-W --keep-going -c ''", 'BUILDDIR=/home/user/mounted_home/_build', '-e', 'version_display_name=None', '-e', 'html_static_path=_static', '-e', 'templates_path=_templates', '-e', 'version_dropdown=', '-j', '4', 'html']' returned non-zero exit status 2.

github-actions · 2026-06-25T18:03:07Z

❌ Docs build failed

Build logs

Cleaning documentation build directory...
Done.
Building documentation...
/home/user/mounted_home/source/reStructuredText.rst:1: CRITICAL: Title overline & underline mismatch.
/home/user/mounted_home/source/index.md:3: WARNING: toctree contains reference to document 'reStructuredText' that doesn't have a title: no link will be generated [toc.no_title]
/home/user/mounted_home/source/index.md:3: WARNING: toctree contains reference to document 'reStructuredText' that doesn't have a title: no link will be generated [toc.no_title]
/home/user/mounted_home/source/index.md:3: WARNING: toctree contains reference to document 'reStructuredText' that doesn't have a title: no link will be generated [toc.no_title]
/home/user/mounted_home/source/index.md:3: WARNING: toctree contains reference to document 'reStructuredText' that doesn't have a title: no link will be generated [toc.no_title]
generating indices... genindex /home/user/mounted_home/source/index.md:3: WARNING: toctree contains reference to document 'reStructuredText' that doesn't have a title: no link will be generated [toc.no_title]
writing additional pages... search /home/user/mounted_home/source/index.md:3: WARNING: toctree contains reference to document 'reStructuredText' that doesn't have a title: no link will be generated [toc.no_title]
Documentation build completed, but with problems that must be resolved.
Re-run with --verbose for full output.

This reverts commit 293fabb.

github-actions · 2026-06-25T18:06:58Z

❌ Docs build failed

Build logs

Cleaning documentation build directory...
Done.
Building documentation...
/home/user/mounted_home/source/reStructuredText.rst:1: CRITICAL: Title overline & underline mismatch.
/home/user/mounted_home/source/index.md:3: WARNING: toctree contains reference to document 'reStructuredText' that doesn't have a title: no link will be generated [toc.no_title]
/home/user/mounted_home/source/index.md:3: WARNING: toctree contains reference to document 'reStructuredText' that doesn't have a title: no link will be generated [toc.no_title]
/home/user/mounted_home/source/index.md:3: WARNING: toctree contains reference to document 'reStructuredText' that doesn't have a title: no link will be generated [toc.no_title]
/home/user/mounted_home/source/index.md:3: WARNING: toctree contains reference to document 'reStructuredText' that doesn't have a title: no link will be generated [toc.no_title]
generating indices... genindex /home/user/mounted_home/source/index.md:3: WARNING: toctree contains reference to document 'reStructuredText' that doesn't have a title: no link will be generated [toc.no_title]
writing additional pages... search /home/user/mounted_home/source/index.md:3: WARNING: toctree contains reference to document 'reStructuredText' that doesn't have a title: no link will be generated [toc.no_title]
Documentation build completed, but with problems that must be resolved.
Re-run with --verbose for full output.

samsrabin added 2 commits June 25, 2026 11:52

Improve test docs.

f77196d

* Add reStructuredText version * Fix formatting in both

Add intentional rST error

293fabb

docs.yml: No verbose.

38249ab

Revert "Add intentional rST error"

1ff3df8

This reverts commit 293fabb.

samsrabin force-pushed the fix-gh-log-verbosity branch from 1ff3df8 to 4d0f7a8 Compare June 25, 2026 18:06

samsrabin force-pushed the fix-gh-log-verbosity branch from 4d0f7a8 to 1ff3df8 Compare June 25, 2026 18:07

samsrabin merged commit 3f74ccd into ESMCI:master Jun 25, 2026
12 checks passed

Navigation Menu

Repository navigation

Fix GitHub log verbosity - #61

Fix GitHub log verbosity#61
samsrabin merged 4 commits into
ESMCI:masterfrom
samsrabin:fix-gh-log-verbosity

samsrabin commented Jun 25, 2026

Uh oh!

github-actions Bot commented Jun 25, 2026

Uh oh!

github-actions Bot commented Jun 25, 2026

Uh oh!

github-actions Bot commented Jun 25, 2026

Uh oh!

github-actions Bot commented Jun 25, 2026

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

samsrabin commented Jun 25, 2026

Uh oh!

github-actions Bot commented Jun 25, 2026

❌ Docs build failed

Uh oh!

github-actions Bot commented Jun 25, 2026

❌ Docs build failed

Uh oh!

github-actions Bot commented Jun 25, 2026

❌ Docs build failed

Uh oh!

github-actions Bot commented Jun 25, 2026

❌ Docs build failed

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant