From 5db6a7808229900d183ff1dcaec82f0a2df449bc Mon Sep 17 00:00:00 2001 From: Oleh Prypin Date: Fri, 30 Jun 2023 15:47:36 +0200 Subject: [PATCH] Deprecate `defaults.get_schema` --- mkdocs/config/defaults.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/mkdocs/config/defaults.py b/mkdocs/config/defaults.py index 1a76f1fa..cf6e630c 100644 --- a/mkdocs/config/defaults.py +++ b/mkdocs/config/defaults.py @@ -8,10 +8,6 @@ from mkdocs.config import config_options as c from mkdocs.utils.yaml import get_yaml_loader, yaml_load -def get_schema() -> base.PlainConfigSchema: - return MkDocsConfig._schema - - # NOTE: The order here is important. During validation some config options # depend on others. So, if config option A depends on B, then A should be # listed higher in the schema. @@ -152,3 +148,8 @@ class MkDocsConfig(base.Config): """Load config options from the open file descriptor of a YAML file.""" loader = get_yaml_loader(config=self) self.load_dict(yaml_load(config_file, loader)) + + +def get_schema() -> base.PlainConfigSchema: + """Soft-deprecated, do not use.""" + return MkDocsConfig._schema