-
Improvement
-
Resolution: Fixed
-
Normal
-
None
-
None
We use sphinx-click to document cli commands automatically. sphinx-click relies on the documentation of the options and arguments to be mentioned as help text in the decorator instead of the docstring of the function. This file needs to be modified.
Here is an example of the wrongly formatted command,
Note how args is mentioned below the command description and some options have no help text.
Here is an example of a properly documented command,