Join GitHub today
Update information on mkdocs build process #4508
This PR should resolve #4507. As per #4231, builds fail with mkdocs when markdown files are not in a
I was able to solve this issue by moving my
Of course, this doesn't solve the issue of builds failing when files are at the root, but users should be aware of the current caveat.
This is my first PR, so I am definitely open to feedback, comments, and questions :)
Thanks for your contribution!
First, I'm not an expert on MkDocs. That said, I tried to find where we do this in our code and I didn't find it. I seems that we only look for
mkdocs.yml at the root of the project:
Reading that code, it seems that we look into the project's root directory and if we don't find it we return
None. Then, we create a
mkdocs.yml with just one entry
site_name and add the
docs_dir (one of
book if any of them exists in that order) at
So, looking at the code it seems that we require a
mkdocs.yml in the root.
I'm a little confused, tough.
The recomended layout for a mkdocs project is
would be a little weird...
makes more sense. So +1 to edit the docs to reflect that.
What @humitos mention is maybe what the docs wanted to say.
That makes sense to me, and I just confirmed that not having
I think the docs don't mention that