Raise clear error when mkdocs.yml config file is missing
#12521
Merged
+95
−38
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
Sorry for being so late.
added MKDOCS_NOT_FOUND constant to ProjectConfigurationError
added MkDocs notification for missing mkdocs.yml
raise MKDOCS_NOT_FOUND when mkdocs.yml is missing
Documentation build overview
Show files changed (7 files in total): 📝 7 modified | ➕ 0 added | ➖ 0 deleted
|
Documentation build overview
Show files changed (11 files in total): 📝 11 modified | ➕ 0 added | ➖ 0 deleted
|
humitos
changed the title
mkdocs.yml config file is missing
humitos
commented
Oct 28, 2025
Comment on lines
-56
to
-58
| # TODO: we should eventually remove this method completely and stop | ||
| # relying on "loading the `mkdocs.yml` file in a safe way just to know | ||
| # if it's a MKDOCS or MKDOCS_HTML documentation type". |
Member
Author
There was a problem hiding this comment.
We are relying on self.config.doctype now which always return mkdocs.
stsewd
reviewed
Nov 3, 2025
stsewd
approved these changes
Nov 5, 2025
Co-authored-by: Santos Gallegos <stsewd@proton.me>
…mitos/followup-12378
…hedocs.org into humitos/followup-12378
Member
Author
|
@copilot make a test case for this PR |
Contributor
MkDocs builds failed with unclear errors when the configuration file was missing. This aligns MkDocs error handling with the existing Sphinx implementation. ### Changes - **Error messaging**: When `mkdocs.configuration` is declared but the file doesn't exist, raises `UserFileNotFound` with the path - **Test coverage**: Added `MkDocsBuilderTest.test_project_without_mkdocs_yml` to verify the error behavior ### Error Examples Missing `mkdocs.configuration` key:  Declared file doesn't exist:  Closes #11937 Closes #12378 <!-- START COPILOT CODING AGENT TIPS --> --- 💡 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](https://gh.io/copilot-coding-agent-tips) in the docs. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: humitos <244656+humitos@users.noreply.github.com>
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.
Follow up from user contributed PR at #12378
This implementation follows the same idea that we have implemented in Sphinx:
mkdocs.configurationYAML key is missing, we show:MkDocs configuration file is missingmkdocs.configurationdoesn't exist, we show:Expected file not found(with the path)Closes #11937
Closes #12378