docs: update RtD guides

balajtimate commented 2 weeks ago

Description

Create in-depth guide for installation, usage and examples hosted on RtD
Update README with quick start guide
Update version to v1.0.0-rc.1
Remove Dockerfile and .dockerignore and the build and publish docker image steps from the CI

Type of change

[X] Documentation update

Checklist

Please carefully read these items and tick them off if the statements are true or do not apply.

[X] I have performed a self-review of my own code
[X] My code follows the existing coding style, lints and generates no new warnings
[X] I have added type annotations to all function/method signatures, and I have added type annotations for any local variables that are non-trivial, potentially ambiguous or might otherwise benefit from explicit typing.
[X] I have commented my code in hard-to-understand areas
[X] I have added ["Google-style docstrings"] to all new modules, classes, methods/functions or updated previously existing ones
[X] I have added tests that prove my fix is effective or that my feature works
[X] New and existing unit tests pass locally with my changes and I have not reduced the code coverage relative to the previous state
[X] I have updated any sections of the app's documentation that are affected by the proposed changes

If for some reason you are unable to tick off all boxes, please leave a comment explaining the issue you are facing so that we can work on it together.

codecov[bot] commented 2 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 100.00%. Comparing base (797abe8) to head (f231a54).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## dev #172 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 13 14 +1 Lines 1165 1166 +1 ========================================= + Hits 1165 1166 +1 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

🚨 Try these New Features:

Flaky Tests Detection - Detect and resolve failed and flaky tests

balajtimate commented 4 days ago

The RtD guide is available at https://htsinfer--172.org.readthedocs.build/en/172/index.html

zavolanlab / htsinfer