Skip to content

Commit 709545d

Browse files
committed
Mkdocs: default to "docs" for docs_dir
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
1 parent 1bf51bd commit 709545d

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

readthedocs/doc_builder/backends/mkdocs.py

+3-4
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,7 @@ def load_yaml_config(self):
115115
)
116116
return {
117117
'site_name': self.version.project.name,
118+
'docs_dir': self.docs_dir(),
118119
}
119120
except yaml.YAMLError as exc:
120121
note = ''
@@ -139,14 +140,12 @@ def append_conf(self):
139140
user_config = self.load_yaml_config()
140141

141142
# Handle custom docs dirs
142-
user_docs_dir = user_config.get('docs_dir')
143-
if not isinstance(user_docs_dir, (type(None), str)):
143+
docs_dir = user_config.get('docs_dir', 'docs')
144+
if not isinstance(docs_dir, (type(None), str)):
144145
raise MkDocsYAMLParseError(
145146
MkDocsYAMLParseError.INVALID_DOCS_DIR_CONFIG,
146147
)
147148

148-
docs_dir = self.docs_dir(docs_dir=user_docs_dir)
149-
150149
self.create_index(extension='md')
151150
user_config['docs_dir'] = docs_dir
152151

0 commit comments

Comments
 (0)