Workspace reference generation
tmuxp 1.74.0 · Source
This page describes the documentation integration for Python. Native CLI references remain compatibility targets until an installed command exists.
Command metadataLink to section
tmuxp uses argparse metadata from create_parser for its upstream Sphinx CLI reference. Its separately installed shtab integration consumes that parser for completion. The documentation adapter must preserve required groups rather than infer arity from optional-looking help.
The command reference covers the Python grammar. A future native export must record command paths, aliases, positional arity, option spellings, types, defaults, choices, required and exclusive groups, store-constant values, repeat and ordering behavior, environment bindings, and child commands. Output schemas and availability belong alongside that metadata.
Generate help, completion, and static reference from the same definitions. Compare generated results in CI and test actual installed help separately. A rendered example or successful parser-only probe does not establish service execution, distribution, or tmux compatibility.
Site integrationLink to section
Keep equivalent task pages at the same workspace path in every port. The existing page switcher offers authored counterparts and leaves absent pages unavailable. A CLI guide and a builder API guide are different counterparts; preserve builder reference as its own surface.
Write executable shell examples per port. Shared console, YAML, and JSON blocks survive language filtering. Installing a native library must not be presented as installing a workspace executable when it has no such artifact.
The site version and workspace package version can differ. Record the package and source revision independently, and do not use an older version-shaped URL to imply that today’s command existed in an older release. This local research prototype is reviewed against current source.
VerificationLink to section
Check configuration, machine output, and compatibility together. Exercise equivalent page paths, API backlinks, fragments, sidebars, metadata exports, search, and preview prefixes in assembled output. Verify command examples against isolated tmux servers, with explicit cleanup and known limitations.