Skip to content

Build failure when generating Sphinx documentation #68196

Closed
@m-saito-fj

Description

@m-saito-fj

The following three files have errors when generating documentation using Sphinx.

  1. llvm/docs/SpeculativeLoadHardening.md
  2. clang/docs/ReleaseNotes.rst
  3. llvm/docs/AMDGPUDwarfExtensionAllowLocationDescriptionOnTheDwarfExpressionStack/AMDGPUDwarfExtensionAllowLocationDescriptionOnTheDwarfExpressionStack.md
  • Error message for the first file

[37/1109] Generating man Sphinx documentation for llvm-dwarfdump into "build/docs/man"
FAILED: docs/CMakeFiles/docs-llvm-dwarfdump-man docs/CMakeFiles/docs-llvm-dwarfdump-man
cd build/docs && /usr/bin/cmake -E env /usr/bin/sphinx-build -b man -d build/docs/_doctrees-llvm-dwarfdump-man -q -t builder-man -D version=18 -D release=18.0.0git -tPreRelease -W llvm-project/llvm/docs build/docs/man

Warning, treated as error:
llvm-project/llvm/docs/SpeculativeLoadHardening.md:3:Non-consecutive header level increase; H1 to H3 [myst.header]

  • Error message for the second file

[378/600] Generating man Sphinx documentation for clang into "build/tools/clang/docs/man" FAILED: tools/clang/docs/CMakeFiles/docs-clang-man build/tools/clang/docs/CMakeFiles/docs-clang-man
cd build/tools/clang/docs && /usr/bin/cmake -E env /usr/bin/sphinx-build -b man -d build/tools/clang/docs/_doctrees-clang-man -q -t builder-man -D version=18 -D release=18.0.0git -tPreRelease -W build/tools/clang/docs build/tools/clang/docs/man

Warning, treated as error:
build/tools/clang/docs/ReleaseNotes.rst:595:Bullet list ends without a blank line; unexpected unindent.

  • Error message for the third file

[11/11] Generating html Sphinx documentation for llvm into "build/docs/html" FAILED: docs/CMakeFiles/docs-llvm-html build/docs/CMakeFiles/docs-llvm-html
cd build/docs && /usr/bin/cmake -E env /usr/bin/sphinx-build -b html -d build/docs/_doctrees-llvm-html -q -t builder-html -D version=18 -D release=18.0.0git -tPreRelease -W llvm-project/llvm/docs build/docs/html

Warning, treated as error:
llvm-project/llvm/docs/AMDGPUDwarfExtensionAllowLocationDescriptionOnTheDwarfExpressionStack/AMDGPUDwarfExtensionAllowLocationDescriptionOnTheDwarfExpressionStack.md:3:'myst' cross-reference target not found: 'extens

[Environment information]
llvm-project main branch (8823e96)
myst-parser version(2.0.0)

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions