search

click-contrib / sphinx-click

A Sphinx plugin to automatically document click-based applications
MIT License
212 stars 57 forks source link

Show list of commands #130

Closed hakonhagland closed 10 months ago

hakonhagland commented 10 months ago

Hi thanks for writing this extension. Is it possible to get a list of commands like I get in the terminal:

$ vscode-cli-helpers-open-file --help
Usage: vscode-cli-helpers-open-file [OPTIONS] COMMAND [ARGS]...

  ``vscode-cli-helpers-open-file`` is a command line tool for opening new or
  existing files in VS Code and navigating to a specific line.

Options:
  -v, --verbose  Show verbose output
  --help         Show this message and exit.

Commands:
  edit-config    ``vscode-cli-helpers-open-file edit-config`` lets you...
  edit-template  ``vscode-cli-helpers-open-file edit-template`` lets you...
  open           ``vscode-cli-helpers-open-file open`` lets you open a...

In the generated sphinx doc for my command, the section with "Commands:" seems to be missing.

stephenfin commented 10 months ago

You want the :nested: short option.