Skip to content

Conversation

@joshuatorrance
Copy link
Collaborator

@joshuatorrance joshuatorrance commented Oct 14, 2025

This PR contains some simple scripts to grab schema from the schema repo and build some docs from them.

The script will be set up to run when there's a commit to this repo (i.e. doc templates or scripts have changed) and probably when some still-to-be-determined activity occurs in the schema repo (although a manual run of the script could work too).

Still to do:

  • Update schema URL to the main repo (once new schema PR is merged)
    • Is there a smart way to point to the most recent version of the schema? Github releases maybe?
  • Take a look at the ordering of the rows in the table, doesn't look right at the moment
    • Hard code order? Alphabetical?
  • Remove "comments" from global table? Would look better on my monitors and info could be in description.
  • Add required as a column
  • Lists with one element should not be dot points
  • Figure out what (if any) activity in the schema repo should trigger a rebuild
  • Flesh out the doc more fully. More descriptions, explanations etc.
  • Consider moving some of these points to new PRs/issues
  • Check directory and file paths are correct
  • Create artifacts on release?
    • pdf - should be created by readthedocs, how to get as release artefact?
  • Zenodo integration on release (needs a release to trigger)
  • readthedocs
  • rename repo?

joshuatorrance and others added 30 commits November 25, 2025 14:51
…ndard_name to fld_* variable names, updated template
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.

2 participants