Add a check to verify mkdocs builds #357
Closed
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
Javagedes
added
documentation
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #357 +/- ##
=======================================
Coverage 71.63% 71.63%
=======================================
Files 48 48
Lines 4813 4813
=======================================
Hits 3448 3448
Misses 1365 1365
Flags with carried forward coverage won't be shown. Click here to find out more. |
Javagedes
force-pushed
the
mkdocs_check
branch
from
1047ad9
to
2ce8029
Compare
Adds a check to the pipeline that verifies mkdocs builds with no errors or warnings. It was chosen to also force users to fix warnings, as the additional pydocstyle linting requirements for mkdocs only show up as warnings if incorrect. Signed-off-by: Joey Vagedes <joeyvagedes@microsoft.com>
Javagedes
force-pushed
the
mkdocs_check
branch
from
2ce8029
to
10e7049
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.
Adds a check to the pipeline that verifies mkdocs builds with no errors or warnings.
It was chosen to also force users to fix warnings, as the additional pydocstyle linting requirements for mkdocs only show up as warnings if incorrect.