Skip to content

generate run arg doc from scripts #747

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
AnguseZhang merged 10 commits into from
Jul 5, 2022
Merged

generate run arg doc from scripts #747

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
809867b
generate run arg doc from scripts
njzjz Jun 8, 2022
31b5f78
remove `init_multi_systems`
njzjz Jun 10, 2022
7f5333b
set repeat=True for model_devi_jobs
njzjz Jun 10, 2022
c215e32
switch to dargs directive
njzjz Jun 11, 2022
64050ed
switch for mdata
njzjz Jun 11, 2022
82757c5
add extension
njzjz Jun 11, 2022
23c7ea1
the current model_devi_args is indeed lammps arguments
njzjz Jun 11, 2022
0470a7e
fix error
njzjz Jun 11, 2022
cbb252f
fix error
njzjz Jun 11, 2022
be17e21
Merge branch 'devel' into run_args
njzjz Jun 19, 2022
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
4 changes: 0 additions & 4 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,9 +106,5 @@ def run_apidoc(_):
main(['-M', '--tocfile', 'api', '-H', 'DP-GEN API', '-o', os.path.join(cur_dir, "api"), module, '--force'])


def generate_arginfo(app):
subprocess.check_output((sys.executable, "gen_arginfo.py"), universal_newlines=True)

def setup(app):
app.connect('builder-inited', run_apidoc)
app.connect('builder-inited', generate_arginfo)
5 changes: 0 additions & 5 deletions doc/gen_arginfo.py
View file
Open in desktop

This file was deleted.

6 changes: 3 additions & 3 deletions doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ DPGEN's documentation

run/run-process.rst
run/param.rst
run-mdata.rst
run/mdata.rst

.. _init::

Expand Down Expand Up @@ -59,14 +59,14 @@ DPGEN's documentation
:caption: Tutorial
:glob:

toymodels/*
Tutorials <https://tutorials.deepmodeling.com/en/latest/Tutorials/DP-GEN/>


.. _Contribution:

.. toctree::
:maxdepth: 2
:caption: Contribution Guild
:caption: Contribution Guide

README.md
api/api
Expand Down
1 change: 1 addition & 0 deletions doc/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,5 @@ sphinx_rtd_theme
sphinx_markdown_tables
myst-parser
deepmodeling_sphinx
dargs>=0.3.1
.
4 changes: 3 additions & 1 deletion doc/run-mdata.rst → doc/run/mdata.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,6 @@ dpgen run 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/dpgen-machine>`_. All parameters below can be set in DP-GUI. By clicking "SAVE JSON", one can download the input file.

.. include:: run-mdata-auto.rst
.. dargs::
:module: dpgen.generator.arginfo
:func: run_mdata_arginfo
Loading