Use with Sphinx
Add dargs.sphinx
to the extensions of conf.py:
extensions = [
'dargs.sphinx',
]
Then dargs directive will be enabled:
.. dargs::
:module: dargs.sphinx
:func: _test_argument
where _test_argument returns an Argument
. A list
of Argument
is also accepted. The documentation will be rendered as:
- test:
- type:
str
argument path:test
This argument is only used to test.