Skip to content

Build failure when generating Sphinx documentation #68196

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
m-saito-fj opened this issue Oct 4, 2023 · 3 comments
Closed

Build failure when generating Sphinx documentation #68196

m-saito-fj opened this issue Oct 4, 2023 · 3 comments

Comments

@m-saito-fj
Copy link

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)

@cor3ntin
Copy link
Contributor

cor3ntin commented Oct 4, 2023

@AaronBallman

@AaronBallman
Copy link
Collaborator

Ugh. Unlike the clang- and llvm- sphinx builders, the sphinx-publish-bot does not go red when the docs are broken and so we have no idea when we break documentation. That's a problem stemming from b7ff032 causing the regular builders to go down. We really need to either get those bots updated or we need to reconfigure the publish bot to start reporting errors. Another thing we should consider is setting up a Sphinx build as part of our GitHub CI pipeline so that developers are alerted to the issues before landing the changes. CC @tstellar @tlattner @gkistanova

@m-saito-fj
Copy link
Author

Sorry for the late confirmation.
I am now ready to build and close.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants