search

meta00 / vital_sqi

A package for physiological signal quality control
MIT License
32 stars 11 forks source link

Sphinx setup #37

Closed bahp closed 3 years ago

bahp commented 3 years ago

Hi Guys,

I have setup sphinx to document the vital_sqi package.

To see the documentation (under construction) it is necessary to either run the sphinx documentation locally and open docs/build/html/index.html or configure the repository (make it a public and add gh-pages).

If everything goes well the old .rst files within docs/source/ can also be removed.

Best

codecov[bot] commented 3 years ago

Codecov Report

Merging #37 (1f2bf05) into main (8549d4d) will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main      #37   +/-   ##
=======================================
  Coverage   28.59%   28.59%           
=======================================
  Files          23       23           
  Lines        1640     1640           
=======================================
  Hits          469      469           
  Misses       1171     1171
Impacted Files Coverage Δ
vital_sqi/__init__.py 100.00% <ø> (ø)
vital_sqi/common/__init__.py 100.00% <ø> (ø)
vital_sqi/data/__init__.py 100.00% <ø> (ø)
vital_sqi/preprocess/__init__.py 100.00% <ø> (ø)
vital_sqi/sqi/__init__.py 100.00% <ø> (ø)
vital_sqi/common/power_spectrum.py 0.00% <0.00%> (ø)

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 8549d4d...1f2bf05. Read the comment docs.

meta00 commented 3 years ago

Thanks @bahp I think it is fine to remove the old .rst files. @Koaha is going to merge the playbook brach into main (without import errors), though not done, so that you can test how to push that on readthedocs. Then it is good to merge.

Koaha commented 3 years ago

@bahp It's great. I updated the notebook examples and turned off the message when importing the package. Please test your setup doc with the example notebooks. Everything is ok to merge. Thanks!