File: groups.rst

package info (click to toggle)
sphinx-click 6.1.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 352 kB
  • sloc: python: 1,038; makefile: 10
file content (25 lines) | stat: -rw-r--r-- 490 bytes parent folder | download | duplicates (3)
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