Skip to content

docs: fix referenced argument func #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 28, 2024
Merged

docs: fix referenced argument func #79

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5712c30
docs: fix referenced argument func
njzjz Oct 28, 2024
f6bed7a
fix
njzjz Oct 28, 2024
6635d91
fix2
njzjz Oct 28, 2024
3cd0d29
Update sphinx.rst
njzjz Oct 28, 2024
b0ac7da
Update sphinx.rst
njzjz Oct 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions docs/sphinx.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ Then `dargs` directive will be enabled:
.. code-block:: rst

.. dargs::
:module: dargs._test
:func: test_argument
:module: dargs.sphinx
:func: _test_argument

where `test_argument` returns an :class:`Argument <dargs.Argument>`. The documentation will be rendered as:
where `_test_argument` returns an :class:`Argument <dargs.Argument>`. The documentation will be rendered as:

.. dargs::
:module: dargs._test
:func: test_argument
:module: dargs.sphinx
:func: _test_argument

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

Expand All @@ -36,8 +36,8 @@ To write Markdown files with `MyST-Parser <https://github.com/executablebooks/My

```{eval-rst}
.. dargs::
:module: dargs._test
:func: test_argument
:module: dargs.sphinx
:func: _test_argument
```

Cross-referencing Arguments
Expand Down