Skip to content

feat: Improve error message for missing mkdocs.yml #12517

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −1
Open

feat: Improve error message for missing mkdocs.yml #12517

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion readthedocs/doc_builder/backends/mkdocs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
from readthedocs.doc_builder.base import BaseBuilder
from readthedocs.projects.constants import MKDOCS
from readthedocs.projects.constants import MKDOCS_HTML
from readthedocs.projects.exceptions import UserFileNotFound


log = structlog.get_logger(__name__)
Expand Down Expand Up @@ -52,7 +53,12 @@ def get_final_doctype(self):

https://www.mkdocs.org/user-guide/configuration/#use_directory_urls
"""

# Check if the mkdocs.yml file exists before trying to open it.
if not os.path.exists(self.yaml_file):
raise UserFileNotFound(
"MkDocs configuration file is missing. "
"A configuration file named `mkdocs.yml` was not found in your repository."
)
# 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".
Expand Down