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

Enable RTD fail on warning #455

Merged
merged 1 commit into from
Jan 17, 2023
Merged

Enable RTD fail on warning #455

merged 1 commit into from
Jan 17, 2023

Conversation

HGSilveri
Copy link
Collaborator

As we have RTD automatically build the docs, sometimes there are warnings we miss that could have let us know something is not quite right.

Since our build runs without warnings under normal circumstances, we can let it fail in the presence of warnings so that we can catch them.

@HGSilveri HGSilveri requested a review from a-corni January 13, 2023 15:07
Copy link
Collaborator

@a-corni a-corni left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From what I have read, it is the best solution to have the build going on and raising all the warnings !

https://stackoverflow.com/questions/61414199/see-all-warnings-as-errors-when-building-sphinx-docs-on-readthedocs-org

@HGSilveri HGSilveri merged commit e68231c into develop Jan 17, 2023
@HGSilveri HGSilveri deleted the rtd-warning-fail branch January 18, 2023 11:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants