Enable warning as errors when building docs #75
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This allows to detect errors when building documentation on PRs before merging. The deploy step will be skipped unless we're pushing to master. Signed-off-by: Nahuel Espinosa <nespinosa@ekumenlabs.com>
Signed-off-by: Nahuel Espinosa <nespinosa@ekumenlabs.com>
nahueespinosa
added
enhancement
ivanpauno
previously approved these changes
Jan 18, 2023
|
This is ready for another pass, I found other minor formatting issues that I couldn't help but try to solve here. |
nahueespinosa
force-pushed
the
nahuel/warn_as_error_in_docs
branch
from
224985a
to
36e25e7
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This allows to detect errors when building documentation on PRs before merging. The deploy step will be skipped unless we're pushing to master. It also fixes minor documentation warnings and formatting issues.
Note: the solutions are not pretty when looking at the markdown, so I'm open to suggestions.