Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/about/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ The current members of the MkDocs-NG team.

### Fixed

* Fix CLI default handling with recent Click versions so omitted options do not override configured `strict`, `use_directory_urls`, or serve reload mode values.
* Fix dropdown submenu arrow invisible in the navigation menu. #44
* Fix malformed URLs (e.g., unterminated IPv6 literals) crashing the entire build. #45
* Fix build crash caused by broken (dangling) symlinks in the docs directory. #46
Expand Down
16 changes: 16 additions & 0 deletions mkdocs/__main__.py
Original file line number Diff line number Diff line change
Expand Up @@ -219,6 +219,19 @@ def callback(ctx, param, value):
)(f)


def unset_default_source_values(kwargs, *names):
ctx = click.get_current_context(silent=True)
if ctx is None:
return

for name in names:
if (
name in kwargs
and ctx.get_parameter_source(name) is click.core.ParameterSource.DEFAULT
):
kwargs[name] = None


common_options = add_options(quiet_option, verbose_option)
common_config_options = add_options(
click.option("-f", "--config-file", type=click.File("rb"), help=config_help),
Expand Down Expand Up @@ -283,6 +296,7 @@ def serve_command(**kwargs):
from mkdocs.commands import serve

_enable_warnings()
unset_default_source_values(kwargs, "build_type", "strict", "use_directory_urls")
serve.serve(**kwargs)


Expand All @@ -296,6 +310,7 @@ def build_command(clean, **kwargs):
from mkdocs.commands import build

_enable_warnings()
unset_default_source_values(kwargs, "strict", "use_directory_urls")
cfg = config.load_config(**kwargs)
cfg.plugins.on_startup(command="build", dirty=not clean)
try:
Expand Down Expand Up @@ -331,6 +346,7 @@ def gh_deploy_command(
from mkdocs.commands import build, gh_deploy

_enable_warnings()
unset_default_source_values(kwargs, "strict", "use_directory_urls")
cfg = config.load_config(
remote_branch=remote_branch, remote_name=remote_name, **kwargs
)
Expand Down
27 changes: 27 additions & 0 deletions mkdocs/tests/cli_tests.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,33 @@ class CLITests(unittest.TestCase):
def setUp(self):
self.runner = CliRunner()

def test_unset_default_source_values_restores_default_values(self):
kwargs = {"build_type": "False", "strict": False, "use_directory_urls": False}
ctx = mock.Mock()
ctx.get_parameter_source.return_value = cli.click.core.ParameterSource.DEFAULT

with mock.patch("mkdocs.__main__.click.get_current_context", return_value=ctx):
cli.unset_default_source_values(
kwargs, "build_type", "strict", "use_directory_urls"
)

self.assertIsNone(kwargs["build_type"])
self.assertIsNone(kwargs["strict"])
self.assertIsNone(kwargs["use_directory_urls"])

def test_unset_default_source_values_preserves_commandline_values(self):
kwargs = {"strict": False, "use_directory_urls": False}
ctx = mock.Mock()
ctx.get_parameter_source.return_value = (
cli.click.core.ParameterSource.COMMANDLINE
)

with mock.patch("mkdocs.__main__.click.get_current_context", return_value=ctx):
cli.unset_default_source_values(kwargs, "strict", "use_directory_urls")

self.assertFalse(kwargs["strict"])
self.assertFalse(kwargs["use_directory_urls"])

@mock.patch("mkdocs.commands.serve.serve", autospec=True)
def test_serve_default(self, mock_serve):
result = self.runner.invoke(cli.cli, ["serve"], catch_exceptions=False)
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ classifiers = [
dynamic = ["version"]
requires-python = ">=3.8"
dependencies = [
"click >=7.0",
"click >=8.1.8",
"Jinja2 >=2.11.1",
"markupsafe >=2.0.1",
"Markdown >=3.3.6",
Expand Down
Loading