Skip to content

feat(themes): add bundled theme defaults and yardang preview#116

Merged
timkpaine merged 1 commit into
python-project-templates:mainfrom
Point72:tkp/themes
Jun 29, 2026
Merged

feat(themes): add bundled theme defaults and yardang preview#116
timkpaine merged 1 commit into
python-project-templates:mainfrom
Point72:tkp/themes

Conversation

@timkpaine

Copy link
Copy Markdown
Member

Ship per-theme defaults and a preview workflow so the docs can be compared across multiple Sphinx themes.

  • pyproject: add themes extra (shibuya, sphinxawesome-theme)
  • build.py: add BUNDLED_THEMES and _resolve_custom_asset for per-theme CSS/JS defaults; add html_output_dir so the HTML output dir can be redirected
  • cli.py: add yardang preview to render the site once per theme; build gains an --output option
  • bundled shibuya.css / sphinxawesome_theme.css defaults
  • docs: document the themes extra, custom-css/js precedence, and previewing
  • ci: build with the working copy, render per-theme previews, publish to gh-pages
  • tests: cover bundled themes and preview behaviour

Ship per-theme defaults and a preview workflow so the docs can be compared
across multiple Sphinx themes.

- pyproject: add `themes` extra (shibuya, sphinxawesome-theme)
- build.py: add BUNDLED_THEMES and _resolve_custom_asset for per-theme CSS/JS
  defaults; add html_output_dir so the HTML output dir can be redirected
- cli.py: add `yardang preview` to render the site once per theme; `build`
  gains an --output option
- bundled shibuya.css / sphinxawesome_theme.css defaults
- docs: document the themes extra, custom-css/js precedence, and previewing
- ci: build with the working copy, render per-theme previews, publish to
  gh-pages
- tests: cover bundled themes and preview behaviour
@codecov

codecov Bot commented Jun 29, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 91.24088% with 12 lines in your changes missing coverage. Please review.
✅ Project coverage is 82.66%. Comparing base (c894454) to head (03af5aa).

Files with missing lines Patch % Lines
yardang/cli.py 62.96% 7 Missing and 3 partials ⚠️
yardang/build.py 93.93% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #116      +/-   ##
==========================================
+ Coverage   80.98%   82.66%   +1.68%     
==========================================
  Files           8        9       +1     
  Lines        1262     1373     +111     
  Branches      138      145       +7     
==========================================
+ Hits         1022     1135     +113     
+ Misses        201      198       -3     
- Partials       39       40       +1     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@timkpaine timkpaine merged commit f066aeb into python-project-templates:main Jun 29, 2026
3 checks passed
@timkpaine timkpaine deleted the tkp/themes branch June 29, 2026 19:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant