33602: Enforce strict checking during the Sphinx documentation build process for azure-maps-render #34887
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
… for azure-maps-render
github-actions
bot
added
Community Contribution
|
Thank you for your contribution @Lakicar95! We will review the pull request and get back to you soon. |
|
@microsoft-github-policy-service agree company="Janea Systems" |
kristapratico
approved these changes
Mar 22, 2024
There was a problem hiding this comment.
@Lakicar95 thank you so much for the contribution! The changes look great - I verified that the documentation renders correctly.
FYI the CI failures are unrelated to the changes in this PR so I'm going to ignore them.
|
/check-enforcer override |
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.
Description
Fix Sphinx errors related to formatting, styling and adopting anonymous links in docstrings. After introducing these changes, we are able to set strict_sphinx to true in pyproject.tom - which enforces strict checking during the Sphinx documentation build process.
Fixes: #33602
How to verify?
`../azure-maps-render>pip install "tox<5"
../azure-maps-render>tox run -e strict-sphinx -c ../../../eng/tox/tox.ini --root .`