Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update RtD guides #172

Merged
merged 25 commits into from
Nov 20, 2024
Merged

docs: update RtD guides #172

merged 25 commits into from
Nov 20, 2024

Conversation

balajtimate
Copy link
Collaborator

@balajtimate balajtimate commented Nov 4, 2024

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

  • Documentation update

Checklist

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

  • I have performed a self-review of my own code
  • My code follows the existing coding style, lints and generates no new
    warnings
  • 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.
  • I have commented my code in hard-to-understand areas
  • I have added ["Google-style docstrings"] to all new modules, classes,
    methods/functions or updated previously existing ones
  • I have added tests that prove my fix is effective or that my feature
    works
  • New and existing unit tests pass locally with my changes and I have not
    reduced the code coverage relative to the previous state
  • 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.

Copy link

codecov bot commented Nov 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (797abe8) to head (f231a54).
Report is 1 commits behind head on dev.

Additional details and impacted files
@@            Coverage Diff            @@
##               dev      #172   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           13        14    +1     
  Lines         1165      1166    +1     
=========================================
+ Hits          1165      1166    +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


🚨 Try these New Features:

@balajtimate balajtimate requested a review from uniqueg November 4, 2024 11:30
docs/index.rst Outdated Show resolved Hide resolved
docs/index.rst Outdated Show resolved Hide resolved
docs/index.rst Outdated Show resolved Hide resolved
docs/index.rst Outdated Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
docs/guides/installation.rst Show resolved Hide resolved
docs/guides/usage.rst Outdated Show resolved Hide resolved
docs/guides/usage.rst Show resolved Hide resolved
docs/guides/usage.rst Outdated Show resolved Hide resolved
docs/guides/examples.rst Outdated Show resolved Hide resolved
@balajtimate
Copy link
Collaborator Author

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

@balajtimate balajtimate enabled auto-merge (squash) November 15, 2024 12:49
Copy link
Member

@uniqueg uniqueg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still a couple of issues :)

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
docs/guides/examples.rst Show resolved Hide resolved
docs/guides/examples.rst Outdated Show resolved Hide resolved
docs/guides/installation.rst Outdated Show resolved Hide resolved
docs/guides/installation.rst Outdated Show resolved Hide resolved
docs/guides/installation.rst Outdated Show resolved Hide resolved
docs/guides/usage.rst Outdated Show resolved Hide resolved
docs/guides/usage.rst Outdated Show resolved Hide resolved
@balajtimate balajtimate requested a review from uniqueg November 18, 2024 18:57
@balajtimate balajtimate merged commit a43cb92 into dev Nov 20, 2024
17 checks passed
@balajtimate balajtimate deleted the docs_update branch November 20, 2024 15:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants