Improved sphinx docs#13
Merged
Merged
Conversation
justusschock
requested review from
dhedey,
ethanwharris,
k223kim and
owbone
as code owners
July 10, 2026 10:44
rusenask
approved these changes
Jul 10, 2026
* Drop the root command heading — the page title already names the command. The root's prose renders in a div.cli-reference container; child sections are hoisted to document level so command headings sit at h2/h3 and the page toc lists them. * Rename "Subcommands" to "Commands", matching the usage line's COMMAND placeholder, the table's own header, and Click's help output. * Link each name in a Commands table to its section on the page, and stop truncating the short-help descriptions at 45 chars. * Render the usage synopsis as a console literal block (highlighting + copy button) instead of an inline literal. * Declutter parameter tables: drop the repeated --help rows, show an argument's Click type instead of its name-echoing metavar, and show "—" instead of `false` for a flag's implicit default. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
dhedey
approved these changes
Jul 15, 2026
owbone
approved these changes
Jul 16, 2026
ethanwharris
approved these changes
Jul 16, 2026
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
5 participants
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.
No description provided.