search

meta00 / vital_sqi

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

setup pkg documentation in readthedocs.io #9

Open meta00 opened 3 years ago

meta00 commented 3 years ago

once all features completed (ecg, ppg)

Koaha commented 3 years ago

added readthedocs branch - /docs/src

TODO: edit readthedocs makefile in the package makefile

bahp commented 3 years ago

The readthedocs has been configured and the branch merged. Please double check in your readthedocs account that the project has compiled properly, if not please do share the log with the errors (I can't see them). Please do also share the readthedocs URL, it should be of the format "https://.readthedocs.io/en/latest". I have tried the following but I don't findit:

https://vital_sqi.readthedocs.io/en/latest/ [not working] https://vitalsqi.readthedocs.io/en/latest/ [not working]

Note: Changing the vital_sqi repository from private to public converted my forked repository into a private one. Thus, I decided to use it as a previous check for both gh-pages and readthedocs and they work fine (see PS below).

PS: https://bahp.github.io/vital-sqi/ PS: https://vital-sqi-rtd-test.readthedocs.io/en/latest/

meta00 commented 3 years ago

@bahp, https://vitalsqi.readthedocs.io/en/latest/ should work now.