fix: remove invalid top-level version key from mkdocs.yml#23
Merged
Conversation
MkDocs does not recognise 'version' as a valid top-level config key. Running with --strict aborted the build with: WARNING - Config value 'version': Unrecognised configuration name: version Aborted with 1 configuration warnings in 'strict' mode! Removing the key fixes the GitHub Pages workflow.
Contributor
There was a problem hiding this comment.
Pull request overview
Removes an invalid top-level version key from mkdocs.yml that causes MkDocs builds to fail in --strict mode, aligning version display with the existing dynamic injection done via the MkDocs macros hook.
Changes:
- Deleted the unsupported top-level
version: "0.5.0"entry frommkdocs.ymlto prevent strict-mode config warnings from aborting the build.
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
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.
Problem
The GitHub Pages deployment was failing because
mkdocs.ymlcontained an unrecognised top-levelversionkey. With--strictmode the build aborted:Fix
Remove the invalid
version: "0.5.0"key frommkdocs.yml. The project version is already dynamically injected at build time via themacros.pydefine_envhook (usingsetuptools_scm), so removing the static key has no effect on the published docs.