docs: freeze 6.3 CLI reference to static rST (OSMO-6482)#1153
Open
samuelhanono-Nvidia wants to merge 1 commit into
Open
docs: freeze 6.3 CLI reference to static rST (OSMO-6482)#1153samuelhanono-Nvidia wants to merge 1 commit into
samuelhanono-Nvidia wants to merge 1 commit into
Conversation
Freeze the 6.3 CLI reference pages to static reStructuredText so the multiversion docs build renders this version's CLI without importing this branch's code. Generated with make -C docs cli-rst. Also widen the credential --payload help table column so the DATA row renders as a valid grid table.
Contributor
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
|
📖 Docs preview: https://d3in15bfzp49i0.cloudfront.net/1153/index.html |
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.
Description
Freeze the 6.3 CLI reference pages to static reStructuredText so the
multiversion docs build renders this version's CLI without importing this
branch's code. Generated with
make -C docs cli-rstin a 6.3 environment: eachpage's
argparse-with-postprocessdirective is replaced by pre-rendered rST(usage, options, sub-commands, examples) plus the
cli_reference_*anchors thatother pages link to.
The deployed multiversion build introspects
main's live CLI parser for everyversion. 6.3 ships
osmo bucketandosmo dataset(both removed onmain), soits live CLI directives raised
NavigationExceptionagainstmain's parser andbroke the docs deploy. Freezing renders these pages from 6.3's own parser —
accurate to what 6.3 shipped and import-free.
Also widen the
osmo credential --payloadhelp table's third column so theDATArow (region, override_url, addressing_style) renders as a valid gridtable. This fixes a pre-existing malformed-table error that only surfaced once
6.3's pages began building. The fix is applied in
src/cli/credential.pyso theterminal
--helpoutput is correct too, then reflected in the regenerated page.Adds the
cli-rstmake target andgenerate_cli_rst.pyso the frozen pages canbe regenerated, mirroring the 6.1 (#1146) and 6.2 (#1147) freezes.
Validated with a local multiversion build (
smv_prefer_remote_refs=Falseagainst this branch): all versions build with zero warnings, 6.3's pages render
with no placeholders, and all cross-references resolve.
Issue #None
Checklist