Skip to content

Commit

Permalink
fix link
Browse files Browse the repository at this point in the history
  • Loading branch information
njzjz authored Oct 9, 2023
1 parent 15e1594 commit 9da4c24
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/dpgui.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
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`:
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>`, :code:`"Test Argument"` is its name that can be any string.
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:

Expand Down

0 comments on commit 9da4c24

Please sign in to comment.