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: use markdown instead of rst #639

Merged
merged 5 commits into from Feb 2, 2024
Merged

docs: use markdown instead of rst #639

merged 5 commits into from Feb 2, 2024

Conversation

bednar
Copy link
Contributor

@bednar bednar commented Feb 1, 2024

Closes #634

Proposed Changes

Migrate README file from rst to markdown.

Updated docs:

Checklist

  • CHANGELOG.md updated
  • Rebased/mergeable
  • pytest tests completes successfully
  • Commit messages are conventional
  • Sign CLA (if not already signed)

@codecov-commenter
Copy link

codecov-commenter commented Feb 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (7a5f655) 90.40% compared to head (fad3946) 90.40%.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #639   +/-   ##
=======================================
  Coverage   90.40%   90.40%           
=======================================
  Files          39       39           
  Lines        3503     3503           
=======================================
  Hits         3167     3167           
  Misses        336      336           

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

@bednar bednar marked this pull request as ready for review February 1, 2024 13:51
Copy link

@karel-rehor karel-rehor left a comment

Choose a reason for hiding this comment

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

It appears the document docs/usage.rst generates an HTML document with only section headers. However, this is the same as in the master branch. Aside from this the PR looks legit.

docs/usage.rst Show resolved Hide resolved
@bednar bednar merged commit 293ed7f into master Feb 2, 2024
14 checks passed
@bednar bednar deleted the readme-to-md branch February 2, 2024 14:41
@bednar bednar added this to the 1.41.0 milestone Feb 2, 2024
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.

README.rst is not rendered correctly on GitHub
3 participants