@@ -10,22 +10,22 @@ sphinx-click
10
10
:target: https://sphinx-click.readthedocs.io/en/latest/?badge=latest
11
11
:alt: Documentation Status
12
12
13
- `sphinx-click ` is a `Sphinx `__ plugin that allows you to automatically extract
14
- documentation from a `click -based `__ application and include it in your docs.
13
+ `` sphinx-click ` ` is a `Sphinx `__ plugin that allows you to automatically extract
14
+ documentation from a `Click -based `__ application and include it in your docs.
15
15
16
16
__ http://www.sphinx-doc.org/
17
17
__ http://click.pocoo.org/
18
18
19
19
Installation
20
20
------------
21
21
22
- Install the plugin using `pip `:
22
+ Install the plugin using `` pip ` `:
23
23
24
24
.. code-block :: shell
25
25
26
26
$ pip install sphinx-click
27
27
28
- Alternatively, install from source by cloning this repo then running `pip `
28
+ Alternatively, install from source by cloning this repo then running `` pip ` `
29
29
locally:
30
30
31
31
.. code-block :: shell
@@ -37,10 +37,10 @@ Usage
37
37
38
38
.. important ::
39
39
40
- To document a click -based application, both the application itself and any
40
+ To document a Click -based application, both the application itself and any
41
41
additional dependencies required by that application **must be installed **.
42
42
43
- Enable the plugin in your Sphinx `conf.py ` file:
43
+ Enable the plugin in your Sphinx `` conf.py` ` ` file:
44
44
45
45
.. code-block :: python
46
46
@@ -57,3 +57,19 @@ documentation.
57
57
58
58
Detailed information on the various options available is provided in the
59
59
`documentation <https://sphinx-click.readthedocs.io >`_.
60
+
61
+ Alternative
62
+ -----------
63
+
64
+ This plugin is perfect to document a Click-based CLI in Sphinx, as it properly
65
+ renders the help screen and its options in nice HTML with deep links and
66
+ styling.
67
+
68
+ However, if you are looking to document the source code of a Click-based CLI,
69
+ and the result of its execution, you might want to check out `click-extra `__.
70
+ The latter provides the ``.. click:example:: `` and ``.. click:run:: `` Sphinx
71
+ directives so you can `capture and render, with full colors, the result of your
72
+ CLI in your documentation `__.
73
+
74
+ __ https://github.com/kdeldycke/click-extra/
75
+ __ https://kdeldycke.github.io/click-extra/sphinx.html
0 commit comments