Document DP-GUI (#34)

deepmodeling · Oct 10, 2023 · aef1574 · aef1574
1 parent 444dd27
commit aef1574
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/docs/dpgui.rst b/docs/dpgui.rst
@@ -0,0 +1,20 @@
+Use with DP-GUI
+===============
+
+Developers can export an :class:`Argument <dargs.Argument>` to `DP-GUI <https://github.com/deepmodeling/dpgui>`_ for users, by adding a :code:`dpgui` entry point to `pyproject.toml`:
+
+.. code-block:: toml
+
+   [project.entry-points."dpgui"]
+    "Test Argument" = "dargs.sphinx:_test_argument"
+
+where `_test_argument` returns an :class:`Argument <dargs.Argument>` or a list of :class:`Argument <dargs.Argument>`, and :code:`"Test Argument"` is its name that can be any string.
+
+Users can install the `dpgui` Python package via `pip` and serve the DP-GUI instance using the `dpgui` command line:
+
+.. code-block:: sh
+
+    pip install dpgui
+    dpgui
+
+The served DP-GUI will automatically load all templates from the :code:`dpgui` entry point.
diff --git a/docs/index.rst b/docs/index.rst
@@ -12,6 +12,7 @@ Welcome to dargs's documentation!
 
    intro
    sphinx
+   dpgui
    api/api
    credits