Skip to content
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

Myst warnings #14952

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Myst warnings #14952

wants to merge 5 commits into from

Conversation

AmosAidoo
Copy link
Contributor

Which issue does this PR close?

Rationale for this change

docs/build.sh produces warnings. This change removes all those warnings and treats subsequent warnings as errors and will cause the CI to fail.

What changes are included in this PR?

  • Replaces invalid links with valid ones.
  • Respects heading hierarchy.
  • Adds -W flag to sphinx-build which treats warnings as errors.

Are these changes tested?

Yes, by running the command with -W without any build errors. I also checked the output html after build.

Are there any user-facing changes?

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 1, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix warnings in doc build
1 participant