diff options
| author | Todd Gamblin <tgamblin@llnl.gov> | 2018-02-11 02:41:41 -0800 |
|---|---|---|
| committer | Todd Gamblin <tgamblin@llnl.gov> | 2018-02-12 20:25:17 -0800 |
| commit | b98cdf098a4d5a5fde005c1394c0a7af986f35c5 (patch) | |
| tree | 2a7c8ba8429ceb95a6da1189838b64977299f35c /lib/spack/docs/command_index.in | |
| parent | 1b998cbeee338a21df7a88ba77577b8f19375cfa (diff) | |
| download | spack-b98cdf098a4d5a5fde005c1394c0a7af986f35c5.tar.gz spack-b98cdf098a4d5a5fde005c1394c0a7af986f35c5.tar.bz2 spack-b98cdf098a4d5a5fde005c1394c0a7af986f35c5.tar.xz spack-b98cdf098a4d5a5fde005c1394c0a7af986f35c5.zip | |
Rework command reference in docs, add `spack commands` command
- command reference now includes usage for all Spack commands as output
by `spack help`. Each command usage links to any related section in
the docs.
- added `spack commands` command which can list command names,
subcommands, and generate RST docs for commands.
- added `llnl.util.argparsewriter`, which analyzes an argparse parser and
calls hooks for description, usage, options, and subcommands
Diffstat (limited to 'lib/spack/docs/command_index.in')
| -rw-r--r-- | lib/spack/docs/command_index.in | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/lib/spack/docs/command_index.in b/lib/spack/docs/command_index.in index 6520352b42..7f1f35c744 100644 --- a/lib/spack/docs/command_index.in +++ b/lib/spack/docs/command_index.in @@ -1,9 +1,9 @@ -============= -Command Index -============= +================= +Command Reference +================= -This is an alphabetical list of commands with links to the places they -appear in the documentation. +This is a reference for all commands in the Spack command line interface. +The same information is available through :ref:`spack-help`. -.. hlist:: - :columns: 3 +Commands that also have sections in the main documentation have a link to +"More documentation". |