Add a shared theme for the PyPTO documentation sites - #4
Merged
Conversation
Share the homepage brand assets, project navigation, responsive layout, and system/light/dark preference across independently built docs. Provide pinned MkDocs/Material constraints and a read-only five-project compatibility workflow, including bilingual PyPTO browser checks. Validate strict builds for five fixed repository snapshots, rendered root/deep pages, mobile layouts, theme persistence, and search within the current language. Document the existing Material/i18n alternate-sitemap and cross-language search limitations separately.
Enable fail-fast shell handling in the shared integration guide so a failed theme download stops before checkout or dependency installation.
lyfne123
added a commit
to lyfne123/pypto
that referenced
this pull request
Sep 9, 2026
Fetch the shared theme at 59c0dc2a456b954ea559a03b9ef8fb72eb3d27cb for CI and local builds, and inherit its branding, layout, project selector, and system/light/dark preference. Keep navigation, translations, API plugins, and link checks in this repository. Use the public pypto.ai URLs and document preview, upgrade, and rollback commands in both languages. The Docs workflow validates the pinned revision before installing the shared renderer constraints. Validate the strict documentation build, repository pre-commit checks, and 24 browser checks against the actual pinned theme checkout. Merge the shared theme in hw-native-sys/hw-native-sys.github.io#4 first; repin after a squash.
Hzfengsy
pushed a commit
to hw-native-sys/pypto
that referenced
this pull request
Sep 9, 2026
PyPTO's documentation currently defines its own appearance separately from the project homepage. This adopts the shared theme's branding, responsive layout, five-project selector, and shared system/light/dark preference while retaining PyPTO's navigation, translations, API plugins, and existing checks. The Docs workflow fetches the full theme commit recorded in `docs/theme-revision.txt` and uses its MkDocs/Material constraints. Public URLs use `www.pypto.ai`. Developer documentation and READMEs stay focused on PyPTO content, with no local-preview or theme-rollback instructions. The shared theme has merged in hw-native-sys/hw-native-sys.github.io#4. This PR pins its merged commit `25e1894636701e2709f4b6cb31d69e9385577231`. Validation: the pinned checkout passes the strict documentation build and applicable pre-commit hooks, including documentation navigation, translation parity, and API coverage checks. The merged shared-theme implementation also passed all five project builds and 24 Chromium checks covering English/Chinese pages, mobile navigation, theme persistence, and search within the current language.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The project documentation sites currently maintain separate layouts and branding. This adds a reusable Material theme with the homepage's brand assets, a five-project selector, responsive reading layouts, and one system/light/dark preference shared across the homepage and documentation.
Consumers fetch a full commit SHA and include local copies of the assets in their independently deployed sites. The maintenance guide covers integration, version updates, and rollback. A read-only workflow builds five fixed downstream snapshots and runs bilingual PyPTO browser checks.
Validation: all five strict documentation builds passed; 14 root/deep rendered pages passed asset and navigation checks; all 24 Chromium checks passed; JavaScript syntax and Ruff checks passed. The Toolkit matrix deliberately tests Material 9.7.7 using a temporary requirements copy because its existing constraint excludes that version.
The unchanged PyPTO baseline has optional alternate-sitemap 404s and a cross-language search redirect issue in Material/i18n. These are documented separately; the browser suite checks search within the current language and keeps other resource and JavaScript failures strict.
Merge this shared theme before the consumer integration. If this PR is squash-merged, consumers must pin and validate the resulting merge commit.