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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
.. sphinxcontrib-autoprogram documentation master file, created by
sphinx-quickstart on Sun Mar 2 02:39:38 2014.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
.. module:: sphinxcontrib.autoprogram
:mod:`sphinxcontrib.autoprogram` --- Documenting CLI programs
=============================================================
.. image:: https://badge.fury.io/py/sphinxcontrib-autoprogram.svg
:target: https://pypi.org/project/sphinxcontrib-autoprogram/
:alt: Latest PyPI version
.. image:: https://readthedocs.org/projects/sphinxcontrib-autoprogram/badge/
:target: https://sphinxcontrib-autoprogram.readthedocs.io/
:alt: Documentation Status
.. image:: https://github.com/sphinx-contrib/autoprogram/workflows/Build%20and%20Test/badge.svg?branch=master
:target: https://github.com/sphinx-contrib/autoprogram/actions
:alt: Build Status
This contrib extension, :mod:`sphinxcontrib.autoprogram`, provides an automated
way to document CLI programs. It scans :class:`argparse.ArgumentParser`
object, and then expands it into a set of :rst:dir:`.. program::` and
:rst:dir:`.. option::` directives.
In order to use it, add :mod:`sphinxcontrib.autoprogram` into
:data:`extensions` list of your Sphinx configuration file (:file:`conf.py`)::
extensions = ['sphinxcontrib.autoprogram']
.. seealso::
Module :mod:`argparse`
This extension assumes a program to document is made using
:mod:`argparse` module which is a part of the Python standard library.
:rst:dir:`.. autoprogram::` directive
-------------------------------------
Its only and simple way to use is :rst:dir:`.. autoprogram::` directive.
It's similar to :mod:`sphinx.ext.autodoc` extension's
:rst:dir:`.. automodule::` and other directives.
For example, given the following Python CLI program (say it's :file:`cli.py`):
.. include:: cli.py
:code:
In order to document the above program:
.. code-block:: rst
.. autoprogram:: cli:parser
:prog: cli.py
That's it. It will be rendered as:
.. autoprogram:: cli:parser
:prog: cli.py
If there are subcommands (subparsers), they are rendered to subsections.
For example, given the following Python CLI program (say it's
:file:`subcmds.py`):
.. include:: subcmds.py
:code:
.. code-block:: rst
.. autoprogram:: subcmds:parser
:prog: subcmds.py
The above reStructuredText will render:
.. autoprogram:: subcmds:parser
:prog: subcmds.py
If there are argument groups, they can optionally be rendered as subsections,
just like subcommands.
For example:
.. include:: cli_with_groups.py
:code:
.. code-block:: rst
.. autoprogram:: cli_with_groups:parser
:prog: cli_with_groups.py
:groups:
The above reStructuredText Text will render:
.. autoprogram:: cli_with_groups:parser
:prog: cli_with_groups.py
:groups:
.. rst:directive:: .. autoprogram:: module:parser
It takes an import name of the parser object. For example, if ``xyz``
variable in ``abcd.efgh`` module refers an :class:`argparse.ArgumentParser`
object:
.. code-block:: rst
.. autoprogram:: abcd.efgh:xyz
The import name also can evaluate other any Python expressions.
For example, if ``get_parser()`` function in ``abcd.efgh`` module creates
an :class:`argparse.ArgumentParser` and returns it:
.. code-block:: rst
.. autoprogram:: abcd.efgh:get_parser()
It also optionally takes an option named ``prog``. If it's not present
``prog`` option uses :class:`~argparse.ArgumentParser` object's
prog_ value.
.. _prog: http://docs.python.org/library/argparse.html#prog
.. _autoprogram-options:
Additional Options for :rst:dir:`.. autoprogram::`
--------------------------------------------------
``:groups:``
Render argument groups as subsections.
.. versionadded:: 0.1.5
``:maxdepth: ##``
Only show subcommands to a depth of ``##``.
.. versionadded:: 0.1.3
``:no_usage_codeblock:``
Don't put the usage text in a :rst:dir:`.. codeblock:: console` directive.
.. versionadded:: 0.1.3
``:start_command: subcommand``
Render document for the given subcommand. ``subcommand`` can be a space
separated list to render a sub-sub-...-command.
.. versionadded:: 0.1.3
``:strip_usage:``
Removes all but the last word in the usage string before the first option,
replaces it with '...', and removes an amount of whitespace to realign
subsequent lines.
.. versionadded:: 0.1.3
Author and license
------------------
The :mod:`sphinxcontrib.autoprogram` is written by `Hong Minhee`__ and
distributed under BSD license.
The source code is maintained under the `GitHub repository`__:
.. sourcecode:: console
$ git clone git://github.com/sphinx-contrib/autoprogram.git
__ https://hongminhee.org/
__ https://github.com/sphinx-contrib/autoprogram
.. include:: changelog.rst
|
