sphinx.rst

Use with Sphinx

Add :mod:`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 :class:`Argument <dargs.Argument>`. The documentation will be rendered as:

.. dargs::
   :module: dargs.sphinx
   :func: _test_argument

A :class:`list` of :class:`Argument <dargs.Argument>` is also accepted.

.. dargs::
   :module: dargs.sphinx
   :func: _test_arguments

Cross-referencing Arguments

Both the following ways will create a cross-reference to the argument:

Both :dargs:argument:`this <test/test_argument>` and :ref:`this <test/test_argument>` will create a cross-reference to the argument!

It will be rendered as:

Both :dargs:argument:`this <test/test_argument>` and :ref:`this <test/test_argument>` will create a cross-reference to the argument!

Index page

The arguments will be added into the :ref:`genindex` page. See :ref:`test_argument <test/test_argument>` in the :ref:`genindex` page.