docs: use dargs directive (#196)

* docs: use dargs directive

* bump dargs version

Author: njzjz

doc/conf.py

@@ -31,6 +31,7 @@
 # ones.
 extensions = [
     'deepmodeling_sphinx',
+    'dargs.sphinx',
     'myst_parser',
     "sphinx_rtd_theme",
     'sphinx.ext.viewcode',
@@ -72,12 +73,9 @@ def run_apidoc(_):
     module = os.path.join(cur_dir, "..", "dpdispatcher")
     main(['-M', '--tocfile', 'api', '-H', 'DPDispatcher API', '-o', os.path.join(cur_dir, "api"), module, '--force'])
 
-def generate_train_input(app):
-    subprocess.check_output((sys.executable, os.path.join("..", "scripts", "script_gen_dargs_docs.py")), universal_newlines=True)
 
 def setup(app):
     app.connect('builder-inited', run_apidoc)
-    app.connect('builder-inited', generate_train_input)
 
 
 intersphinx_mapping = {

doc/examples/shell.md

@@ -1,4 +1,4 @@
-## Running multiple MD tasks on a GPU workstation
+# Running multiple MD tasks on a GPU workstation
 
 In this example, we are going to show how to run multiple MD tasks on a GPU workstation. This workstation does not install any job scheduling packages installed, so we will use `Shell` as `batch_type`.
 

doc/machine.rst

@@ -3,4 +3,6 @@ Machine parameters
 .. note::
    One can load, modify, and export the input file by using our effective web-based tool `DP-GUI <https://deepmodeling.com/dpgui/input/dpdispatcher-machine>`_. All parameters below can be set in DP-GUI. By clicking "SAVE JSON", one can download the input file.
 
-.. include:: machine-auto.rst
+.. dargs::
+   :module: dpdispatcher.arginfo
+   :func: machine_dargs

doc/resources.rst

@@ -3,4 +3,6 @@ Resources parameters
 .. note::
    One can load, modify, and export the input file by using our effective web-based tool `DP-GUI <https://deepmodeling.com/dpgui/input/dpdispatcher-resources>`_. All parameters below can be set in DP-GUI. By clicking "SAVE JSON", one can download the input file for.
 
-.. include:: resources-auto.rst
+.. dargs::
+   :module: dpdispatcher.arginfo
+   :func: resources_dargs

doc/task.rst

@@ -3,4 +3,6 @@ Task parameters
 .. note::
    One can load, modify, and export the input file by using our effective web-based tool `DP-GUI <https://deepmodeling.com/dpgui/input/dpdispatcher-task>`_. All parameters below can be set in DP-GUI. By clicking "SAVE JSON", one can download the input file.
 
-.. include:: task-auto.rst
+.. dargs::
+   :module: dpdispatcher.arginfo
+   :func: task_dargs

dpdispatcher/arginfo.py

@@ -0,0 +1,6 @@
+from dpdispatcher.submission import Resources, Task
+from dpdispatcher.machine import Machine
+
+resources_dargs = Resources.arginfo
+machine_dargs = Machine.arginfo
+task_dargs = Task.arginfo

setup.py

@@ -40,7 +40,7 @@
     keywords='deep potential generator active learning deepmd-kit',
     install_requires=install_requires,    
     extras_require={
-        'docs': ['sphinx', 'myst-parser', 'sphinx_rtd_theme>=1.0.0rc1', 'numpydoc', 'deepmodeling_sphinx'],
+        'docs': ['sphinx', 'myst-parser', 'sphinx_rtd_theme>=1.0.0rc1', 'numpydoc', 'deepmodeling_sphinx', 'dargs>=0.3.1'],
         "cloudserver": ["oss2", "tqdm"],
         ":python_version<'3.7'": ["typing_extensions"],
     },