Mkdocs: default to "docs" for docs_dir #7766
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
This value has been the default since the start of the project https://github.com/mkdocs/mkdocs/blob/0.13.0/mkdocs/config/defaults.py#L44 We should respect that default value, (we should actually don't edit it at all #2483). So, instead of trying to guess the docs dir always, only try to guess it if the user doesn't have mkdocs.yaml file. This should avoid any backwards compatibility and avoid weird bugs to new users. Closes #7539
stsewd
force-pushed
the
mkdocs-default-to-docs
branch
from
cadf4d7
to
4f08404
Compare
ericholscher
approved these changes
Jan 12, 2021
| @@ -139,14 +140,12 @@ def append_conf(self): | |||
| user_config = self.load_yaml_config() | |||
|
|
|||
| # Handle custom docs dirs | |||
| user_docs_dir = user_config.get('docs_dir') | |||
There was a problem hiding this comment.
It seems like we were respecting the users docs_dir setting here, weren't we? This PR just changes it to default to docs for users who didn't define one?
There was a problem hiding this comment.
yeah, we still respect the value set by the user
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.
This value has been the default since the start of the project
https://github.com/mkdocs/mkdocs/blob/0.13.0/mkdocs/config/defaults.py#L44
We should respect that default value,
(we should actually don't edit it at all #2483).
So, instead of trying to guess the docs dir always,
only try to guess it if the user doesn't have mkdocs.yaml file.
This should avoid any backwards incompatibility and avoid weird bugs to
new users till we completely remove all magic.
Closes #7539