Skip to content

List klink in the theme previews #154

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
timkpaine merged 2 commits into from
Sep 8, 2026
Merged

List klink in the theme previews #154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bb9c092
List klink in the theme previews
timkpaine Sep 8, 2026
d51863d
Drop the unreachable skip in the preview link test
timkpaine Sep 8, 2026
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
3 changes: 2 additions & 1 deletion docs/src/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ yardang preview
```

This renders the documentation into `docs/html/_previews/<theme>/` 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
Expand All @@ -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`

Expand Down
9 changes: 9 additions & 0 deletions yardang/tests/test_themes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."""

Expand Down