Skip to content

Update documentation to OasisLMF/OasisPlatform 2.5.4#47

Merged
sambles merged 2 commits into
mainfrom
update/docs-for-2.5.4
Jun 17, 2026
Merged

Update documentation to OasisLMF/OasisPlatform 2.5.4#47
sambles merged 2 commits into
mainfrom
update/docs-for-2.5.4

Conversation

@benhayes21

Copy link
Copy Markdown
Contributor

Summary

  • Bumps PLAT_VER in update-redoc.py from 2.5.0 → 2.5.4 and regenerates all four OpenAPI/settings JSON schemas
  • Replaces stale 1.4.x OasisLMF changelog and broken OasisPlatform include directive with full 2.5.0–2.5.4 changelogs
  • Updates Python minimum requirement 3.8 → 3.10 across all relevant pages
  • Documents new oasislmf CLI subcommands (generate-pre-loss, generate-post-file-gen, generate-losses-chunk, generate-losses-output, run-postanalysis, generate-doc, warmup, API client commands)
  • Adds macOS Apple Silicon installation section and JIT cache warmup guide
  • Updates ods_tools compatibility table (adds 3.2.x, 4.0.x, 5.0.x entries); rewrites ODS-tools page with combine and generate commands
  • Fixes broken/stale OED links (repo moved from OpenDataStandardsODS_OpenExposureData, docs reorganised under Docs/); updates spec format reference xlsx → CSV (OEDInputFields.csv, v4.0.0+); adds Marine Cargo section
  • Updates container_configuration.rst: psycopg2 → psycopg driver string, API_AUTH_TYPE=disabled, server-internal RUN_MODE, Celery SSL/TLS env vars (v2.5.2+)
  • Updates distributed_execution.rst: renames ktools_*kernel_* params (v2.5.3), removes raw_output_locations (removed in v2.5.4)
  • Adds four new model entries to Oasis-models page: Dynamic Footprint, PiWind Vulnerability Adjustments, PiWind S3, PiWind Azure

Test plan

  • Run make html in GenerateDocs/ to verify Sphinx build passes without errors
  • Check all new changelog links resolve to valid GitHub PRs
  • Verify regenerated JSON schemas in src/schema/ match OasisPlatform 2.5.4 release

🤖 Generated with Claude Code

Brings all docs in sync with the 2.5.x release series:

- Bump PLAT_VER in update-redoc.py from 2.5.0 → 2.5.4 and regenerate
  all four OpenAPI/settings JSON schemas
- Add 2.5.0–2.5.4 changelogs for OasisLMF and OasisPlatform (replacing
  the stale 1.4.x history and the broken include directive)
- Update Python minimum requirement 3.8 → 3.10
- Document new oasislmf CLI subcommands, utility commands (warmup,
  config, version, admin, test), and API client commands
- Add macOS Apple Silicon installation section and JIT cache warmup guide
- Update ods_tools compatibility table to include 3.2.x/4.0.x/5.0.x
- Rewrite ODS-tools page: add combine and generate commands, update
  convert/check option lists
- Fix OED page: broken/stale links, xlsx → CSV spec (v4.0.0), add
  marine cargo section, fix repo path changes
- container_configuration.rst: update psycopg driver string, add
  API_AUTH_TYPE=disabled, server-internal RUN_MODE, Celery SSL/TLS vars
- distributed_execution.rst: rename ktools_* → kernel_*, remove
  raw_output_locations (removed in 2.5.4)
- Oasis-models.rst: add Dynamic Footprint, PiWind Vulnerability
  Adjustments, PiWind S3, and PiWind Azure model entries

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Jun 12, 2026

Copy link
Copy Markdown
PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-06-17 09:34 UTC

@sambles sambles mentioned this pull request Jun 12, 2026
@sambles sambles self-requested a review June 12, 2026 13:31
@sambles

sambles commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

Thanks for fixing, i made a note to do this. (but forgot)

Comments:

  • Do we use the files releases/oasis_platform.rst releases/oasislmf.rst? might be better to ditch these and link to the release note pages, seems a pain to keep inline

  • I don't think the schema/< json file> data is needed. The schema viewers pulls then info from a url (but dosen't hurt to have a copy)

@benhayes21 benhayes21 removed the request for review from sambles June 15, 2026 08:07
Per Sam's review comment on PR #47: maintaining inline RST changelogs
is ongoing toil. Replace oasislmf.rst and oasis_platform.rst with
simple link-out pages pointing to GitHub releases, and wire them into
the Releases toctree so they're navigable from the docs.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@benhayes21

Copy link
Copy Markdown
Contributor Author

The schema files are actually load-bearing for the build — conf.py references them by local filesystem path ('spec': 'schema/platform-1.json' etc.), so Sphinx reads them from disk at build time. Without them committed, every build environment would need to run update-redoc.py first to generate them.

That said, you're right that sphinxcontrib-redoc can also accept URLs as the spec value, so it would be possible to switch to pointing directly at the GitHub release asset URLs and then gitignore src/schema/. Happy to do that as a follow-up if you'd prefer it — just out of scope for this PR.

@benhayes21

Copy link
Copy Markdown
Contributor Author

Changelogs have been replaced with links to the GH release page though @sambles

@sambles sambles merged commit b3e75e5 into main Jun 17, 2026
1 check passed
@sambles sambles deleted the update/docs-for-2.5.4 branch June 17, 2026 09:33
sambles added a commit that referenced this pull request Jun 17, 2026
* Update documentation to OasisLMF/OasisPlatform 2.5.4

Brings all docs in sync with the 2.5.x release series:

- Bump PLAT_VER in update-redoc.py from 2.5.0 → 2.5.4 and regenerate
  all four OpenAPI/settings JSON schemas
- Add 2.5.0–2.5.4 changelogs for OasisLMF and OasisPlatform (replacing
  the stale 1.4.x history and the broken include directive)
- Update Python minimum requirement 3.8 → 3.10
- Document new oasislmf CLI subcommands, utility commands (warmup,
  config, version, admin, test), and API client commands
- Add macOS Apple Silicon installation section and JIT cache warmup guide
- Update ods_tools compatibility table to include 3.2.x/4.0.x/5.0.x
- Rewrite ODS-tools page: add combine and generate commands, update
  convert/check option lists
- Fix OED page: broken/stale links, xlsx → CSV spec (v4.0.0), add
  marine cargo section, fix repo path changes
- container_configuration.rst: update psycopg driver string, add
  API_AUTH_TYPE=disabled, server-internal RUN_MODE, Celery SSL/TLS vars
- distributed_execution.rst: rename ktools_* → kernel_*, remove
  raw_output_locations (removed in 2.5.4)
- Oasis-models.rst: add Dynamic Footprint, PiWind Vulnerability
  Adjustments, PiWind S3, and PiWind Azure model entries

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* Replace inline changelogs with links to GitHub releases pages

Per Sam's review comment on PR #47: maintaining inline RST changelogs
is ongoing toil. Replace oasislmf.rst and oasis_platform.rst with
simple link-out pages pointing to GitHub releases, and wire them into
the Releases toctree so they're navigable from the docs.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

* Add oasislmf api client CLI documentation (closes #31)

Adds a new section (sections/api-client.rst) covering the oasislmf api
subcommand — the recommended way for model developers to validate a model
against a worker container before distributing it.

Documents all six subcommands (run, generate-oasis-files, generate-losses,
list, get, delete), all three auth modes (simple/oidc/m2m) with example
credentials JSON, a step-by-step testing workflow, and config-file usage.

Cross-linked from OasisLMF-package.rst and added to the main toctree.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-authored-by: sambles <sambles@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants