Skip to content

docs(cli): Add reference pages for undocumented CLI commands - #247

Open
svekars wants to merge 1 commit into
Lightning-AI:mainfrom
svekars:svekars/docs-cli-missing-groups
Open

svekars wants to merge 1 commit into
Lightning-AI:mainfrom
svekars:svekars/docs-cli-missing-groups

Conversation

@svekars

@svekars svekars commented Nov 13, 2026

Copy link
Copy Markdown

Summary

The CLI reference shows a command only when python/docs/cli has an .rst page whose lightning-reference directive renders it and index.rst lists that page. Nothing checked this, so nine visible top-level commands were missing from the published reference: auth, teamspace, user, vm, pipeline, connection, ls, rm and edit.

  • Adds a page for each, in the same form as cp.rst, and lists them in index.rst.
  • Adds tests/cli/test_docs_reference.py, which fails when a visible top-level command has no page, or a page isn't in the index. Hidden commands are skipped, and login, logout and completion are covered by the index page.

dataset is hidden, so it stays out; #27 covers documenting it.

Checks

  • pytest tests/cli/test_docs_reference.py passes. Without the new pages it fails and names all nine commands.
  • make html SPHINXOPTS="-W --keep-going" in python/docs/cli succeeds, and the new pages render their commands, e.g. lightning auth whoami and lightning teamspace secret set.
  • ruff check and ruff format --check pass on the new test.

— Claude Opus 5.5, on direct instruction; text not reviewed

The CLI reference has a page for a command only when docs/cli has an .rst
file that renders it and index.rst lists it. auth, teamspace, user, vm,
pipeline, connection, ls, rm and edit had none, so they were missing from
the published reference. Add a page for each, and a test that fails when a
visible top-level command has no page or a page isn't in the index.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@svekars
svekars marked this pull request as ready for review November 13, 2026 22:06
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.

1 participant