rux doc
Purpose
Generate package documentation
Synopsis
rux doc [options]
Behavior
Runs the same folded, semantically checked frontend as rux check, then documents public modules, types, functions, constants, fields, variants, interface members, externs, and public extension methods. --document-private-items includes private items. Consecutive outer /// comments attach when no blank line intervenes and support safe Markdown; raw HTML is escaped and unsafe link schemes are omitted. Foreign supported targets and repeated --define values select the API that is generated.
Arguments
This command accepts no operands.
Options
| Option | Description |
|---|---|
--define <name[=value]> | Set or override a config compile-time value |
--document-private-items | Include private declarations and members |
-o, --output <dir> | Write the generated site to this directory |
--open | Open the generated documentation index in a browser |
--target <triple> | Document APIs enabled for a supported target |
Global options may appear before or after the command. See Global options.
Output and exit status
The default is [Build].Output/Docs (normally Bin/Docs). A workspace gets a landing page and one member section; dependencies are excluded. Generation is deterministic and self-contained. Rux writes through a temporary directory, marks managed output, and refuses to replace a non-empty unmarked directory. --open launches the generated index only after success.
Success exits 0, invalid command-line usage exits 2, and compiler, validation, filesystem, network, or generation failures exit 1 unless stated otherwise above.
Examples
rux doc
rux doc --open
Environment variables
This command defines no command-specific environment variables.
The global color environment behavior is described under Global options.