Skip to content

mkdocs doesn't look in the root of the repo #4507

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.

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

Closed
AumitLeon opened this issue Aug 12, 2018 · 2 comments · Fixed by #4508
Closed

mkdocs doesn't look in the root of the repo #4507

AumitLeon opened this issue Aug 12, 2018 · 2 comments · Fixed by #4508
Labels
Support Support question

Comments

@AumitLeon
Copy link
Contributor

AumitLeon commented Aug 12, 2018

When you choose Mkdocs as your Documentation Type, we will first look for a mkdocs.yml file in the root of your repository. If we don’t find one, we will generate one for you.

The above is not true. I had a project with mkdocs.yml in the root (along with relevant markdown files), and the build failed-- I was getting the same error referenced in #4231.

@stsewd
Copy link
Member

stsewd commented Aug 13, 2018

A link to your rtd project and build would be helpful here, anyway, I think your issue was because of the docs_dir was at the same level of the mkdocs.yml file instead of a child directory, and btw, I think you mention that moving all inside docs solved the issue. It does, but we are not longer reading your mkdocs.yml file, but generating one for you in the root of your project.

@AumitLeon
Copy link
Contributor Author

AumitLeon commented Aug 13, 2018

Ah, you are correct! Just tested this here: AumitLeon/module_starter_cli#35. I updated #4508 to include info on where .md files are sourced from specifically.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Support Support question
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants