refactor: migrate mkdocstrings MkDocs plugin replacement

Signed-off-by: squidfunk <martin.donath@squidfunk.com>
This commit is contained in:
squidfunk
2026-09-01 18:35:44 +02:00
parent ff11fe3ef4
commit 3a390c7647
4 changed files with 85 additions and 36 deletions
+37
View File
@@ -0,0 +1,37 @@
# Copyright (c) 2025-2026 Zensical and contributors
# SPDX-License-Identifier: MIT
# All contributions are certified under the DCO
"""Integration tests for MkDocs-compatible mkdocstrings artifacts."""
from __future__ import annotations
from typing import TYPE_CHECKING, Any
import zensical
if TYPE_CHECKING:
from pathlib import Path
_BUILD_OPTIONS: dict[str, Any] = {"clean": False, "strict": False}
def test_object_inventory_is_restored_from_cache(tmp_path: Path) -> None:
"""The cached inventory is published when no handler updates it."""
docs = tmp_path / "docs"
docs.mkdir()
(docs / "index.md").write_text("# Home\n", encoding="utf-8")
config = tmp_path / "zensical.toml"
config.write_text('[project]\nsite_name = "Inventory"\n', encoding="utf-8")
cache = tmp_path / ".cache"
cache.mkdir()
inventory = b"cached object inventory"
(cache / "objects.inv").write_bytes(inventory)
zensical.build(str(config), _BUILD_OPTIONS)
assert (tmp_path / "site" / "objects.inv").read_bytes() == inventory
assert (cache / "objects.inv").read_bytes() == inventory