Repository navigation
Conversation
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
marked this pull request as ready for review
November 13, 2026 22:06
svekars
requested review from
dhedey,
ethanwharris,
justusschock,
k223kim,
owbone,
rusenask and
tejapulagam
as code owners
November 13, 2026 22:06
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.
Summary
The CLI reference shows a command only when
python/docs/clihas an.rstpage whoselightning-referencedirective renders it andindex.rstlists that page. Nothing checked this, so nine visible top-level commands were missing from the published reference:auth,teamspace,user,vm,pipeline,connection,ls,rmandedit.cp.rst, and lists them inindex.rst.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, andlogin,logoutandcompletionare covered by the index page.datasetis hidden, so it stays out; #27 covers documenting it.Checks
pytest tests/cli/test_docs_reference.pypasses. Without the new pages it fails and names all nine commands.make html SPHINXOPTS="-W --keep-going"inpython/docs/clisucceeds, and the new pages render their commands, e.g.lightning auth whoamiandlightning teamspace secret set.ruff checkandruff format --checkpass on the new test.— Claude Opus 5.5, on direct instruction; text not reviewed