Improve docs configuration and fix anchor links #504
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
|
Review changes with |
mschoettle
commented
Nov 29, 2024
joseluisq
added
documentation
joseluisq
requested changes
Nov 29, 2024
mschoettle
force-pushed
the
improve-docs
branch
from
f6b270e to
398ce62
Compare
joseluisq
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Description
Resolves all info/warnings output by
mkdocs.Adds
--strictto the deploy command. Validation by mkdocs set towarn.Related Issue
Motivation and Context
Building the documentation site showed some issues with non-existent anchors.
mkdocscan treat such things as warnings which makes it more visible and building with--strictcan fail the build process. This helps find issues quicker.How Has This Been Tested?
mkdocs build --strictScreenshots (if appropriate):