Some comments about Docstrings and documentation

[AKuederle]

• [x] The docstring formatting is inconsistent. Some functions use a numpydoc format while others use a GoogleDoc (?) style format (e.g. https://github.com/Aminsinichi/wearable-hrv/blob/ac22c3784c3952a67536c9c976a755827c136dc5/wearablehrv/individual.py#L1552)
• [x] It would be great, if a rendered API docu (e.g. using RTD) would exist to easier browse the available functions
• [x] The main Documentation example should be restructured, that it can be run without modification end-to-end, so that new users can play around with the functionality right away. For this I would suggest replacing, the "undefined" paths with paths to the example file, splitting the docs up into multiple files (1 showing the main functionality and multiple others showing specific functionality, e.g. pre-processing for a specific system)
• [x] Ideally, rendered versions of the example notebook should be hosted somewhere (e.g. as part of RTD page), so that potential users can see the functionality "in action" without installing the package
• [x] If you want to be "fancy" with the handling of your example files, consider using https://pypi.org/project/pooch/ to handle downloading your example files.
• [x] The current documentation notebook has a syntax error in the first cell (missing ! to mark the first line as command)
• [ ] Ideally add a test that executes your documentation example to make sure that it is working as expected.

[Aminsinichi]

• [x] Updated the docstrings to have a consistent format, commit1: individual.py, commit2: group.py
• [x] Thank you for the very helpful suggestion. I have added API documentation, which is now accessible at readthedocs. These are the related commits: commit1, commit2, commit3, and I added to the readme.md commit4.

[Aminsinichi]

• [x] I added data.py to the main root that has a few functions and uses pooch. This will help automatically download the example data, and extract their Path for immediate execution of all the functions; related commit.

[Aminsinichi]

Thank you very much for these suggestions. I made many changes based on your comments, summarized below:

• I removed the previous documentation and completely changed it. I have now created several .ipynb examples that show different functionalities step by step. There is also an overview notebook that shows some of the main functionalities of the package. These are all now listed in the README.md, and are located at docs/examples; Related commit.
• Thanks to pooch, users can now download sample data into their Cache, and then I retrieve the Path and read those files into the pipeline. So, they can now explore all the functions without modifying any code.
• I completely changed the README.md file. It now contains the output images of the “overview.ipynb” notebook, so users can see what it may look like before installing it.
• I also added Binder, so they can try the notebook examples; Related commit.
• I have also changed and updated the RTD documentation, and also host the outputs of the overview notebook there: https://wearable-hrv.readthedocs.io/en/latest/