Schema catalog static site and GitHub Pages#422
Merged
yatharthranjan merged 2 commits intomasterfrom Apr 15, 2026
Merged
Conversation
Add a Python script that builds a static HTML catalog from commons/ and specifications/, grouped by data source with merged payload fields and dynamic table columns. Deploy to GitHub Pages from master via Actions. Also ignore Python __pycache__ and bytecode in .gitignore.
Member
|
Very nice. |
Member
|
Perhaps also needs a link to the page static page placed into the Schema repo |
Member
Author
this combines info from both specs and schemas (you can see specification links at top of each source table)
Thanks, yes good idea, will add. |
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
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.
Summary
This PR adds a static HTML data source catalog generated from
commons/andspecifications/, plus a workflow to publish it to GitHub Pages whenmasteris updated (path-filtered).Changes
scripts/generate_schema_catalog.py— Builds the catalog: sections by data source (Garmin, Fitbit, Apple Health, etc.), one measurements table per source (with empty columns omitted per source), merged Avro field list with common metadata fields omitted, latest aRMT spec only, Apple Health / HealthKit extra block, search and styling..github/workflows/schema-catalog-pages.yml— Install PyYAML, run the generator to_site, deploy viaactions/deploy-pages(push tomasteronly for deploy; PRs validate the build).requirements-docs.txt— PyYAML for the script..gitignore—__pycache__/,*.py[cod], existing entries for_site/and.venv-docs/.Follow-up
Enable GitHub Pages with source GitHub Actions in repo settings if not already configured.
How to test locally
Example screenshot of the generated site -