Skip to content

docs: switch to dargs directive #1753

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
wanghan-iapcm merged 1 commit into from
Jun 11, 2022
Merged

docs: switch to dargs directive #1753

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 1 addition & 5 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,10 +131,6 @@ def generate_doxygen_xml(app):
else:
subprocess.call("doxygen Doxyfile", shell=True)

def generate_train_input(app):
with open("train-input-auto.rst", 'w') as f:
f.write(subprocess.check_output((sys.executable, "-m", "deepmd", "doc-train-input"), universal_newlines=True))

def run_apidoc(_):
from sphinx.ext.apidoc import main
import sys
Expand All @@ -148,7 +144,6 @@ def setup(app):
# Add hook for building doxygen xml when needed
app.connect("builder-inited", generate_doxygen_xml)
app.connect('builder-inited', run_apidoc)
app.connect('builder-inited', generate_train_input)

# -- General configuration ---------------------------------------------------

Expand All @@ -169,6 +164,7 @@ def setup(app):

extensions = [
"deepmodeling_sphinx",
"dargs.sphinx",
"sphinx_rtd_theme",
'myst_parser',
'sphinx.ext.autosummary',
Expand Down
16 changes: 15 additions & 1 deletion doc/train/train-input.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,18 @@ Training 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/deepmd-kit-2.0>`_. All training parameters below can be set in DP-GUI. By clicking "SAVE JSON", one can download the input file for furthur training.

.. include:: ../train-input-auto.rst
.. dargs::
:module: deepmd.utils.argcheck
:func: model_args

.. dargs::
:module: deepmd.utils.argcheck
:func: learning_rate_args

.. dargs::
:module: deepmd.utils.argcheck
:func: loss_args

.. dargs::
:module: deepmd.utils.argcheck
:func: training_args
2 changes: 1 addition & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@
cmake_minimum_required_version="3.0",
extras_require={
"test": ["dpdata>=0.1.9", "ase", "pytest", "pytest-cov", "pytest-sugar"],
"docs": ["sphinx>=3.1.1", "recommonmark", "sphinx_rtd_theme>=1.0.0rc1", "sphinx_markdown_tables", "myst-parser", "breathe", "exhale", "numpydoc", "ase", "deepmodeling-sphinx"],
"docs": ["sphinx>=3.1.1", "recommonmark", "sphinx_rtd_theme>=1.0.0rc1", "sphinx_markdown_tables", "myst-parser", "breathe", "exhale", "numpydoc", "ase", "deepmodeling-sphinx", "dargs>=0.3.1"],
**extras_require,
},
entry_points={"console_scripts": ["dp = deepmd.entrypoints.main:main"]},
Expand Down