docs: enable Sphinx nitpicky mode #11684
Merged
Conversation
This file contains hidden or 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
See: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-nitpicky This ensures we have no more broken references.
bluetech
force-pushed
the
docs-nitpicky
branch
from
c58792c to
2aa8743
Compare
Pierre-Sassoulas
approved these changes
Dec 7, 2023
|
some of the changes look like something that ought to be a correct link any idea if those are actually fixable? |
Yep, it's unrelated.
Which of the changes? |
|
Apologies, upon reading again i realized those are the intentionally broken refs to local path details |
nicoddemus
approved these changes
Dec 7, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
See:
https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-nitpicky
This ensures we have no more broken references.