diff --git a/docs/src/configuration.md b/docs/src/configuration.md index f6c5c4fe..d1b1ed3b 100644 --- a/docs/src/configuration.md +++ b/docs/src/configuration.md @@ -282,7 +282,7 @@ yardang preview ``` This renders the documentation into `docs/html/_previews//` for each -bundled theme (`furo`, `sphinxawesome_theme`, `shibuya`, `fuma`). Themes whose +bundled theme (`furo`, `sphinxawesome_theme`, `shibuya`, `fuma`, `klink`). Themes whose package is not installed are skipped. Restrict the set with `--themes`: ```bash @@ -303,6 +303,7 @@ each theme is browsable live at a suburl of the published site: - [`/_previews/sphinxawesome_theme/`](https://yardang.python-templates.dev/_previews/sphinxawesome_theme/) - [`/_previews/shibuya/`](https://yardang.python-templates.dev/_previews/shibuya/) - [`/_previews/fuma/`](https://yardang.python-templates.dev/_previews/fuma/) +- [`/_previews/klink/`](https://yardang.python-templates.dev/_previews/klink/) ## `source-dir` diff --git a/yardang/tests/test_themes.py b/yardang/tests/test_themes.py index 7593a611..9347276a 100644 --- a/yardang/tests/test_themes.py +++ b/yardang/tests/test_themes.py @@ -32,6 +32,15 @@ def test_other_themes_are_unchanged(self): assert build_module.theme_module("furo") == "furo" +class TestDocumentedThemes: + """The theme lists in the docs are maintained by hand, so they drift.""" + + @pytest.mark.parametrize("theme", BUNDLED_THEMES) + def test_theme_has_a_preview_link(self, theme): + docs = Path(__file__).parents[2] / "docs" / "src" / "configuration.md" + assert f"/_previews/{theme}/" in docs.read_text() + + class TestSearchIntegration: """Search is theme-independent, so it is wired for every first-class theme."""