sphinx-argparse
sphinx-argparse copied to clipboard
Include specified type in the html
Problem
When writing arguments using argparse
, one often includes the type of the variable (e.g., str
, np.int32
).
However as far as I can tell, when using sphinx-argparse this type is not included in the documentation.
I also cannot seem to find how to include the type anywhere in the documentation.
While errors are obviously thrown if the type of the argument is incorrect, is there a way to include the type of the argument that is include in the add_argument
function in the documentation?
Example
parser.add_argument(
'--hello', dest='hello', type=str, default='Hello world!'
)
should give something in the documentation html like
--train type: str
Default: 'Hello world!'