1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25
|
Documenting groups
==================
Consider the following sample application, using |Group|_:
.. literalinclude:: ../../examples/groups/cli.py
This can be documented using *sphinx-click* like so:
.. code-block:: rst
.. click:: groups.cli:cli
:prog: cli
:nested: full
The rendered example is shown below.
----
.. click:: groups.cli:cli
:prog: cli
:nested: full
.. |Group| replace:: ``Groups``
.. _Group: https://click.palletsprojects.com/en/7.x/api/#click.Group
|