Skip to content
New issue

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

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

Already on GitHub? # to your account

Cleanup docs warnings #35473

Closed
sf1919 opened this issue Apr 24, 2023 · 2 comments · Fixed by #35602
Closed

Cleanup docs warnings #35473

sf1919 opened this issue Apr 24, 2023 · 2 comments · Fixed by #35602
Assignees
Labels
Documentation Issues and pull requests related to documentation Maintenance Unassigned issues to be addressed in the next maintenance period.

Comments

@sf1919
Copy link
Contributor

sf1919 commented Apr 24, 2023

Describe the outcome that is desired.
We are getting a lot of warnings when building the documentation. The ideal would be to have 0 warnings

Describe any solutions you are considering
Clean up documentation .

@sf1919 sf1919 added Documentation Issues and pull requests related to documentation Maintenance Unassigned issues to be addressed in the next maintenance period. labels Apr 24, 2023
@sf1919 sf1919 self-assigned this Apr 24, 2023
@sf1919 sf1919 changed the title Cleanup docs warning Cleanup docs warnings Apr 24, 2023
@peterfpeterson
Copy link
Member

peterfpeterson commented Apr 24, 2023

My preference is that part of properly collecting the release notes together is to turn on -W on the sphinx build which will convert warnings to errors. It'd be even better if we could fix up the amalgamate directive (written by us) to fix up the bullet lists when it collects them so we could have the flag turned on all the time. I found another project that simplified turning on the functionality as a cmake option. Somewhere in the top leve add

if (SPHINX_WARNINGS_AS_ERRORS)
  set(SPHINX_WARNINGS_AS_ERRORS_FLAG "-W")
else()
  set(SPHINX_WARNINGS_AS_ERRORS_FLAG "")
endif()

then when the sphinx targets get added, do something like add ${SPHINX_WARNINGS_AS_ERRORS_FLAG} to the list of arguments.

@mantid-builder
Copy link
Collaborator

Fixed by #35602

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
Documentation Issues and pull requests related to documentation Maintenance Unassigned issues to be addressed in the next maintenance period.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants