Skip to content

Build: "Unknown" error when mkdocs.yml is not found #11937

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

Jump to bottom
Open
humitos opened this issue Jan 21, 2025 · 3 comments · May be fixed by #12012
Open

Build: "Unknown" error when mkdocs.yml is not found #11937

humitos opened this issue Jan 21, 2025 · 3 comments · May be fixed by #12012
Labels
Good First Issue Good for new contributors Improvement Minor improvement to code

Comments

@humitos
Copy link
Member

humitos commented Jan 21, 2025

We are currently showing an "Unknown error" when the user defines a mkdocs.configuration pointing to a file that doesn't exist.

Image

However, for a similar error on Sphinx we have a lot nicer error message

Image

It would be great to show a similar message for MkDocs.
@humitos humitos added the Improvement Minor improvement to code label Jan 21, 2025
@github-project-automation github-project-automation bot moved this to Planned in 📍Roadmap Jan 21, 2025
@ericholscher ericholscher added the Good First Issue Good for new contributors label Jan 28, 2025
@silentfatez
Copy link

Can i please try to work on this issue?

@humitos
Copy link
Member Author

humitos commented Feb 19, 2025

@silentfatez yes, feel free to take a look at it an open a PR.

@silentfatez
Copy link

take

@silentfatez silentfatez linked a pull request Feb 20, 2025 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Good First Issue Good for new contributors Improvement Minor improvement to code
Projects
📍Roadmap
Status: Planned
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

amended mkdocs missing message to allign with sphinx silentfatez/readthedocs.org
3 participants
@ericholscher @humitos @silentfatez