Skip to content

Test gh pages docs build #180

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
codingjoe merged 2 commits into from
Dec 17, 2025
Merged

Test gh pages docs build #180

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
2472420
Test gh pages docs build
codingjoe Dec 17, 2025
cbafb99
Update .github/workflows/release.yml
codingjoe Dec 17, 2025
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
9 changes: 9 additions & 0 deletions .github/workflows/release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,16 @@ on:
release:
types: [published]
workflow_dispatch:
permissions:
contents: write
jobs:
gh-pages:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- run: sudo apt-get update && sudo apt-get install -y gettext
- uses: astral-sh/setup-uv@v7
Copy link

Copilot AI Dec 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The deploy job should run the apt-get update and install gettext before running mkdocs, similar to the CI workflow's docs job and other jobs in ci.yml. The gettext package is required by the build-system as specified in pyproject.toml (flit-gettext), and the docs build may fail without it.

Copilot uses AI. Check for mistakes.
- run: uv run mkdocs gh-deploy --force
pypi-build:
runs-on: ubuntu-latest
steps:
Expand Down
3 changes: 3 additions & 0 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,18 @@ theme:
name: material
palette:
- media: "(prefers-color-scheme)"
primary: teal
toggle:
icon: material/brightness-auto
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
primary: teal
scheme: default
toggle:
icon: material/brightness-7
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
primary: teal
scheme: slate
toggle:
icon: material/brightness-4
Expand Down