Update documentation to OasisLMF/OasisPlatform 2.5.4#47
Conversation
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>
|
|
Thanks for fixing, i made a note to do this. (but forgot) Comments:
|
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>
|
The schema files are actually load-bearing for the build — That said, you're right that |
|
Changelogs have been replaced with links to the GH release page though @sambles |
* 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>
Summary
PLAT_VERinupdate-redoc.pyfrom 2.5.0 → 2.5.4 and regenerates all four OpenAPI/settings JSON schemasincludedirective with full 2.5.0–2.5.4 changelogsgenerate-pre-loss,generate-post-file-gen,generate-losses-chunk,generate-losses-output,run-postanalysis,generate-doc,warmup, API client commands)combineandgeneratecommandsOpenDataStandards→ODS_OpenExposureData, docs reorganised underDocs/); updates spec format reference xlsx → CSV (OEDInputFields.csv, v4.0.0+); adds Marine Cargo sectioncontainer_configuration.rst: psycopg2 → psycopg driver string,API_AUTH_TYPE=disabled,server-internalRUN_MODE, Celery SSL/TLS env vars (v2.5.2+)distributed_execution.rst: renamesktools_*→kernel_*params (v2.5.3), removesraw_output_locations(removed in v2.5.4)Test plan
make htmlinGenerateDocs/to verify Sphinx build passes without errorssrc/schema/match OasisPlatform 2.5.4 release🤖 Generated with Claude Code