From 5712c307f0b76bcda4cb5f6d37d153c71bca546d Mon Sep 17 00:00:00 2001 From: Jinzhe Zeng Date: Mon, 28 Oct 2024 01:07:00 -0400 Subject: [PATCH 1/5] docs: fix referenced argument func --- docs/sphinx.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/sphinx.rst b/docs/sphinx.rst index fcfc62c..f200930 100644 --- a/docs/sphinx.rst +++ b/docs/sphinx.rst @@ -16,13 +16,13 @@ Then `dargs` directive will be enabled: .. dargs:: :module: dargs._test - :func: test_argument + :func: test_arguments -where `test_argument` returns an :class:`Argument `. The documentation will be rendered as: +where `test_arguments` returns an :class:`Argument `. The documentation will be rendered as: .. dargs:: :module: dargs._test - :func: test_argument + :func: test_arguments A :class:`list` of :class:`Argument ` is also accepted. @@ -37,7 +37,7 @@ To write Markdown files with `MyST-Parser Date: Mon, 28 Oct 2024 01:14:07 -0400 Subject: [PATCH 2/5] fix --- docs/sphinx.rst | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/sphinx.rst b/docs/sphinx.rst index f200930..4043aa1 100644 --- a/docs/sphinx.rst +++ b/docs/sphinx.rst @@ -15,20 +15,20 @@ Then `dargs` directive will be enabled: .. code-block:: rst .. dargs:: - :module: dargs._test - :func: test_arguments + :module: dargs.sphinx + :func: test_argument -where `test_arguments` returns an :class:`Argument `. The documentation will be rendered as: +where `test_argument` returns an :class:`Argument `. The documentation will be rendered as: .. dargs:: - :module: dargs._test - :func: test_arguments + :module: dargs.sphinx + :func: test_argument A :class:`list` of :class:`Argument ` is also accepted. .. dargs:: - :module: dargs._test - :func: test_arguments + :module: dargs.sphinx + :func: test_argument To write Markdown files with `MyST-Parser `_, one can use: @@ -36,8 +36,8 @@ To write Markdown files with `MyST-Parser Date: Mon, 28 Oct 2024 01:14:33 -0400 Subject: [PATCH 3/5] fix2 --- docs/sphinx.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/sphinx.rst b/docs/sphinx.rst index 4043aa1..30abe4d 100644 --- a/docs/sphinx.rst +++ b/docs/sphinx.rst @@ -27,8 +27,8 @@ where `test_argument` returns an :class:`Argument `. The documen A :class:`list` of :class:`Argument ` is also accepted. .. dargs:: - :module: dargs.sphinx - :func: test_argument + :module: dargs.test + :func: test_arguments To write Markdown files with `MyST-Parser `_, one can use: From 3cd0d29f57dc3d8f92e8a81abe93f63aabd6465a Mon Sep 17 00:00:00 2001 From: Jinzhe Zeng Date: Mon, 28 Oct 2024 01:14:55 -0400 Subject: [PATCH 4/5] Update sphinx.rst --- docs/sphinx.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/sphinx.rst b/docs/sphinx.rst index 30abe4d..baf4aef 100644 --- a/docs/sphinx.rst +++ b/docs/sphinx.rst @@ -27,7 +27,7 @@ where `test_argument` returns an :class:`Argument `. The documen A :class:`list` of :class:`Argument ` is also accepted. .. dargs:: - :module: dargs.test + :module: dargs._test :func: test_arguments To write Markdown files with `MyST-Parser `_, one can use: From b0ac7da0532155f5500bf579d8e2ed1aa495e2bd Mon Sep 17 00:00:00 2001 From: Jinzhe Zeng Date: Mon, 28 Oct 2024 01:19:02 -0400 Subject: [PATCH 5/5] Update sphinx.rst --- docs/sphinx.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/sphinx.rst b/docs/sphinx.rst index baf4aef..891f047 100644 --- a/docs/sphinx.rst +++ b/docs/sphinx.rst @@ -16,13 +16,13 @@ Then `dargs` directive will be enabled: .. dargs:: :module: dargs.sphinx - :func: test_argument + :func: _test_argument -where `test_argument` returns an :class:`Argument `. The documentation will be rendered as: +where `_test_argument` returns an :class:`Argument `. The documentation will be rendered as: .. dargs:: :module: dargs.sphinx - :func: test_argument + :func: _test_argument A :class:`list` of :class:`Argument ` is also accepted. @@ -37,7 +37,7 @@ To write Markdown files with `MyST-Parser