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

add sphinx plugins viewcode and intersphinx #997

Merged
merged 1 commit into from
Aug 20, 2021

Conversation

njzjz
Copy link
Member

@njzjz njzjz commented Aug 19, 2021

See here for preview.
viewcode add a link in each class to the source code.
intersphinx add a link in each type hint to the documentation of Python, NumPy, and TensorFlow.

PS: some type hints are wrong, hence the link is not generated. For example,

eval(coords: numpy.array, cells: numpy.array, atom_types: List[int], atomic: bool = False, fparam: Optional[numpy.array] = None, aparam: Optional[numpy.array] = None, efield: Optional[numpy.array] = None) → Tuple[numpy.ndarray, ...]

numpy.array should be numpy.ndarray.

@codecov-commenter
Copy link

Codecov Report

Merging #997 (eb68a76) into devel (cf3e7d9) will decrease coverage by 18.99%.
The diff coverage is n/a.

❗ Current head eb68a76 differs from pull request most recent head 120a5e9. Consider uploading reports for the commit 120a5e9 to get more accurate results
Impacted file tree graph

@@             Coverage Diff             @@
##            devel     #997       +/-   ##
===========================================
- Coverage   83.27%   64.28%   -19.00%     
===========================================
  Files         118        5      -113     
  Lines        9980       14     -9966     
===========================================
- Hits         8311        9     -8302     
+ Misses       1669        5     -1664     
Impacted Files Coverage Δ
deepmd/entrypoints/train.py
deepmd/infer/deep_eval.py
source/op/_soft_min_virial_grad.py
source/lib/tests/test_soft_min_switch_force.cc
deepmd/__init__.py
deepmd/calculator.py
deepmd/fit/__init__.py
deepmd/entrypoints/config.py
deepmd/infer/data_modifier.py
deepmd/descriptor/se_a_ef.py
... and 103 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 cf3e7d9...120a5e9. Read the comment docs.

@amcadmus amcadmus merged commit f3b08b3 into deepmodeling:devel Aug 20, 2021
gzq942560379 pushed a commit to HPC-AI-Team/deepmd-kit that referenced this pull request Sep 2, 2021
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.

3 participants