Raise clear error when mkdocs.yml config file is missing
#12607
Merged
+61
−0
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
Co-authored-by: humitos <244656+humitos@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Raise clear error when mkdocs.yml config file is missing
Raise clear error when Nov 26, 2025
mkdocs.yml config file is missing
Copilot finished work on behalf of
humitos
November 26, 2025 11:35
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.
MkDocs builds failed with unclear errors when the configuration file was missing. This aligns MkDocs error handling with the existing Sphinx implementation.
Changes
mkdocs.configurationis declared but the file doesn't exist, raisesUserFileNotFoundwith the pathMkDocsBuilderTest.test_project_without_mkdocs_ymlto verify the error behaviorError Examples
Missing
mkdocs.configurationkey:Declared file doesn't exist:
Closes #11937
Closes #12378
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.