Skip to content

Raise clear error when mkdocs.yml config file is missing #12521

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
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Raise clear error when mkdocs.yml config file is missing #12521

wants to merge 9 commits into from
+38 −15

Conversation

humitos
Copy link
Member

@humitos humitos commented Oct 13, 2025 •
edited
Loading

Follow up from user contributed PR at #12378

This implementation follows the same idea that we have implemented in Sphinx:

  • if mkdocs.configuration YAML key is missing, we show: MkDocs configuration file is missing
  • if the file declared in mkdocs.configuration doesn't exist, we show: Expected file not found (with the path)

Closes #11937
Closes #12378

RabbitAlbatross and others added 8 commits August 4, 2025 21:49
@RabbitAlbatross
fix(build): raise clear error if mkdocs.yml config file is missing
1c5b771
@RabbitAlbatross
fix import order to satisfy Ruff
364220e
@RabbitAlbatross
Update mkdocs.py
16fea11 
Sorry for being so late.
@RabbitAlbatross
Update exceptions.py
354cff2 
added MKDOCS_NOT_FOUND constant to ProjectConfigurationError
@RabbitAlbatross
Update notifications.py
032a0bb 
added MkDocs notification for missing mkdocs.yml
@RabbitAlbatross
Update mkdocs.py
b0837a9 
raise MKDOCS_NOT_FOUND when mkdocs.yml is missing
@RabbitAlbatross
Fixing minor mistake in import of mkdocs.py
ded0110
@RabbitAlbatross
yaml import problem fixed
f5900ce
@read-the-docs-community Read the Docs Community
Copy link

read-the-docs-community bot commented Oct 13, 2025 •
edited
Loading

Documentation build overview

📚 dev | 🛠️ Build #29920908 | 📁 Comparing fbe1745 against latest (b971a08)


🔍 Preview build

Show files changed (1 files in total): 📝 1 modified | ➕ 0 added | ➖ 0 deleted
File Status
settings.html 📝 modified

@read-the-docs-community Read the Docs Community
Copy link

read-the-docs-community bot commented Oct 13, 2025 •
edited
Loading

Documentation build overview

📚 docs | 🛠️ Build #29920909 | 📁 Comparing fbe1745 against latest (b971a08)


🔍 Preview build

Show files changed (9 files in total): 📝 9 modified | ➕ 0 added | ➖ 0 deleted
File Status
build-customization.html 📝 modified
visual-diff.html 📝 modified
config-file/index.html 📝 modified
config-file/v2.html 📝 modified
guides/conda.html 📝 modified
guides/private-submodules.html 📝 modified
guides/pull-requests.html 📝 modified
intro/add-project.html 📝 modified
reference/git-integration.html 📝 modified

@humitos humitos changed the title fix(build): raise clear error if mkdocs.yml config file is missing Raise clear error when mkdocs.yml config file is missing Oct 13, 2025
@humitos humitos mentioned this pull request Oct 13, 2025
Open
@humitos humitos marked this pull request as ready for review October 13, 2025 10:24
@humitos humitos requested a review from a team as a code owner October 13, 2025 10:24
@humitos humitos requested a review from stsewd October 13, 2025 10:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@stsewd stsewd Awaiting requested review from stsewd stsewd is a code owner automatically assigned from readthedocs/backend

At least 1 approving review is required to merge this pull request.

Assignees

@humitos humitos

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

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

2 participants

@humitos @RabbitAlbatross