Skip to content

docs: freeze 6.3 CLI reference to static rST (OSMO-6482)#1153

Open
samuelhanono-Nvidia wants to merge 1 commit into
release/6.3from
docs/freeze-cli-rst-6.3
Open

docs: freeze 6.3 CLI reference to static rST (OSMO-6482)#1153
samuelhanono-Nvidia wants to merge 1 commit into
release/6.3from
docs/freeze-cli-rst-6.3

Conversation

@samuelhanono-Nvidia

Copy link
Copy Markdown
Collaborator

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-rst in a 6.3 environment: each
page's argparse-with-postprocess directive is replaced by pre-rendered rST
(usage, options, sub-commands, examples) plus the cli_reference_* anchors that
other pages link to.

The deployed multiversion build introspects main's live CLI parser for every
version. 6.3 ships osmo bucket and osmo dataset (both removed on main), so
its live CLI directives raised NavigationException against main's parser and
broke 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 --payload help table's third column so the
DATA row (region, override_url, addressing_style) renders as a valid grid
table. 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.py so the
terminal --help output is correct too, then reflected in the regenerated page.

Adds the cli-rst make target and generate_cli_rst.py so the frozen pages can
be regenerated, mirroring the 6.1 (#1146) and 6.2 (#1147) freezes.

Validated with a local multiversion build (smv_prefer_remote_refs=False
against this branch): all versions build with zero warnings, 6.3's pages render
with no placeholders, and all cross-references resolve.

Issue #None

Checklist

  • I am familiar with the Contributing Guidelines.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

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.
@samuelhanono-Nvidia samuelhanono-Nvidia requested a review from a team June 26, 2026 04:37
@samuelhanono-Nvidia samuelhanono-Nvidia requested a review from a team as a code owner June 26, 2026 04:37
@coderabbitai

coderabbitai Bot commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 8d8cfdb6-daec-4a5f-8c63-d92de1d5ddbf

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/freeze-cli-rst-6.3

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

external The author is not in @NVIDIA/osmo-dev

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant