Skip to content
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

Prepare code for custo mkdocs.yaml location #4184

Merged
merged 11 commits into from Jun 7, 2018

Conversation

@stsewd
Copy link
Member

@stsewd stsewd commented Jun 5, 2018

This fix #3249

Our docs mention that we search for the mkdocs.yaml inside the docs directory, but that's a lie, we only search in the root of the project. Also, this will prepare our code for the mkdocs key of the new yaml file.

@stsewd
Copy link
Member Author

@stsewd stsewd commented Jun 5, 2018

I need to do this for the others builders and use the --config-file option and a manual QA

@stsewd
Copy link
Member Author

@stsewd stsewd commented Jun 5, 2018

Some changes depend on #4041

@stsewd
Copy link
Member Author

@stsewd stsewd commented Jun 5, 2018

OK, I tested this manually with two projects (mkdocs and #3249 (comment)) it works as expected, going to block this due #4041

@stsewd
Copy link
Member Author

@stsewd stsewd commented Jun 7, 2018

Updated and tested, just to note that this feature doesn't work as the initially reported issue because of https://www.mkdocs.org/about/release-notes/#stricter-directory-validation. this is more useful for people that have a layout like:

  • someproject/docs/
  • someproject/mkdocs.yml
  • readme.md

So, people need to install a previous version of mkdocs for it to works in a structure like the above.

For that reason, I decided to no implement that.

Is this PR still useful?

Yes, with this we can support the mkdocs.configuration key. We can modify this later to read the value from the rtd configuration file. Also, I had added some tests :)

@stsewd stsewd requested a review from Jun 7, 2018
@stsewd stsewd changed the title Search for mkdocs.yaml inside other directories Prepare code for custo mkdocs.yaml location Jun 7, 2018
@ericholscher
Copy link
Member

@ericholscher ericholscher commented Jun 7, 2018

Looks good. 👍

@ericholscher ericholscher merged commit 349963d into readthedocs:master Jun 7, 2018
1 check passed
@stsewd stsewd deleted the mkdocs-search-yaml branch Jun 7, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

2 participants