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 command collections
===============================
Consider the following sample application, using |CommandCollection|_:
.. literalinclude:: ../../examples/commandcollections/cli.py
This can be documented using *sphinx-click* like so:
.. code-block:: rst
.. click:: commandcollections.cli:cli
:prog: cli
:nested: full
The rendered example is shown below.
----
.. click:: commandcollections.cli:cli
:prog: cli
:nested: full
.. |CommandCollection| replace:: ``CommandCollection``
.. _CommandCollection: https://click.palletsprojects.com/en/7.x/api/#click.CommandCollection
|
