feat: Improve error message for missing mkdocs.yml #12517
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 pull request addresses the issue where a generic "Unknown error" is shown when a user's mkdocs.yml configuration file is missing. The new behavior provides a clear, actionable error message, consistent with how similar errors are handled for Sphinx.
Fixes: #12378
Problem
-When mkdocs.configuration points to a non-existent file, the build fails with a vague "Unknown problem" message.
-This provides a poor user experience as the root cause of the failure is not obvious.
Solution
-The get_final_doctype method in the BaseMkdocs builder (readthedocs/doc_builder/backends/mkdocs.py) has been updated.
-An os.path.exists() check is now performed to verify that the mkdocs.yml file exists before any attempt is made to read it.
-If the file is not found, a UserFileNotFound exception is raised with a clear error message, instructing the user to check for the missing file.