Enable nitpicky mode when building the docs #1558
Open
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
* as [mentioned on the forum](https://forum.qubes-os.org/t/version-4-3-0-rc3-not-available-incoherent-with-documentation/36843/6), the 4.3 schedule was wrong, so I removed the rc3 date. * more links to the website news page should help users to figure out what the latest release candidate available is. * I created a direct reference to a useful header on version-scheme.rst and updated the text and the references * There is a minor formatting improvement on the version-scheme.rst and a link to the schedule of R4.1 to provide a concrete example.
The new header in `resize-disk-image` is far from perfect but it allows us to enable nitpicky mode by default, so that any contributor is warned about missing references when building the docs.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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 PR depends on #1537 and #1557.
See the Sphinx docs about
nitpickyconfig value