SMTG-Bham / easyunfold

Band structure unfolding made easy!
https://smtg-bham.github.io/easyunfold/
MIT License
42 stars 12 forks source link

Documentation update #17

Closed zhubonan closed 1 year ago

zhubonan commented 1 year ago

Change the documentation system to use Sphinx with myst-markdown. Sphinx allows automatic python API and CLI documentation generation directly during the build stage.

codecov[bot] commented 1 year ago

Codecov Report

Merging #17 (e623ee0) into main (f741702) will increase coverage by 0.00%. The diff coverage is 100.00%.

:exclamation: Current head e623ee0 differs from pull request most recent head 7231ad8. Consider uploading reports for the commit 7231ad8 to get more accurate results

@@           Coverage Diff           @@
##             main      #17   +/-   ##
=======================================
  Coverage   88.56%   88.57%           
=======================================
  Files           8        8           
  Lines        1399     1400    +1     
=======================================
+ Hits         1239     1240    +1     
  Misses        160      160           
Impacted Files Coverage Δ
easyunfold/plotting.py 92.12% <100.00%> (+0.03%) :arrow_up:

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more