Skip to content
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.

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

generate Python API document automatically #998

Merged
merged 3 commits into from
Aug 20, 2021

Conversation

njzjz
Copy link
Member

@njzjz njzjz commented Aug 20, 2021

@njzjz njzjz requested review from amcadmus and tuoping August 20, 2021 06:00
@codecov-commenter
Copy link

codecov-commenter commented Aug 20, 2021

Codecov Report

Merging #998 (6818c1e) into devel (f3b08b3) will increase coverage by 7.81%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##            devel     #998      +/-   ##
==========================================
+ Coverage   75.46%   83.27%   +7.81%     
==========================================
  Files          85      118      +33     
  Lines        6794     9980    +3186     
==========================================
+ Hits         5127     8311    +3184     
- Misses       1667     1669       +2     
Impacted Files Coverage Δ
source/lib/tests/test_pair_tab.cc 100.00% <0.00%> (ø)
source/lib/tests/test_prod_virial_a.cc 100.00% <0.00%> (ø)
source/api_cc/tests/test_deepdipole.cc 100.00% <0.00%> (ø)
source/lib/tests/test_coord.cc 100.00% <0.00%> (ø)
source/lib/tests/test_neighbor_list.cc 100.00% <0.00%> (ø)
source/api_cc/tests/test_deeppot_model_devi.cc 100.00% <0.00%> (ø)
source/lib/tests/test_prod_virial_grad_a.cc 100.00% <0.00%> (ø)
source/lib/tests/test_main.cc 100.00% <0.00%> (ø)
...ource/lib/tests/test_soft_min_switch_force_grad.cc 100.00% <0.00%> (ø)
source/lib/tests/test_map_aparam.cc 100.00% <0.00%> (ø)
... and 23 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f3b08b3...6818c1e. Read the comment docs.

@njzjz
Copy link
Member Author

njzjz commented Aug 20, 2021

What do you think better, put modules (e.g. deepmd.descriptor.hybrid and deepmd.descriptor.loc_frame) in a single page (deepmd.descriptor), or in the separated pages?

@amcadmus amcadmus merged commit 106f570 into deepmodeling:devel Aug 20, 2021
gzq942560379 pushed a commit to HPC-AI-Team/deepmd-kit that referenced this pull request Sep 2, 2021
* generate Python API document automatically

* add `ase` to generate `deepmd.calculator`

* fix `ase` intersphinx_mapping
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants