Allow build mkdocs outside root #5539
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Currently we are expecting that all mkdocs projects have their docs in their root, but we generate the artifacts relative to their yaml file, we do the same for sphinx. Fix readthedocs#5532 (comment)
Old mkdocs projects rely on an auto generated file for this. We write to this location some default values when we don't find one.
stsewd
commented
Mar 27, 2019
| @@ -76,8 +76,6 @@ def get_yaml_config(self): | |||
| self.project.checkout_path(self.version.slug), | |||
| 'mkdocs.yml', | |||
| ) | |||
| if not os.path.exists(mkdoc_path): | |||
| return None | |||
There was a problem hiding this comment.
This was removed to keep compatibility (see the 2nd commit message)
stsewd
commented
Mar 27, 2019
| @@ -112,9 +110,6 @@ def append_conf(self, **__): | |||
| :raises: ``MkDocsYAMLParseError`` if failed due to known type errors | |||
| (i.e. expecting a list and a string is found). | |||
| """ | |||
| if not self.yaml_file: | |||
| self.yaml_file = os.path.join(self.root_path, 'mkdocs.yml') | |||
|
|
|||
There was a problem hiding this comment.
This is already handled above
And we check for not existing files here
stsewd
removed
the
PR: work in progress
This was referenced Mar 29, 2019
orlnub123
approved these changes
Apr 3, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently we are expecting that all mkdocs projects have their docs in
their root, but we generate the artifacts relative to their yaml file,
we do the same for sphinx.
https://github.com/rtfd/readthedocs.org/blob/d8a6c24013b7089074b302e7c04edd7998fe90ce/readthedocs/doc_builder/backends/sphinx.py#L42-L51
Fix #5532 (comment)
Closes #5559