WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content

Conversation

@andreoliwa
Copy link
Owner

Proposed changes

  1. Convert all docs from ReST to Markdown

Checklist

  • Read the contribution guidelines
  • Run make locally before pushing commits
  • Add tests for the relevant parts:
    • API
    • CLI
    • flake8 plugin (normal mode)
    • flake8 plugin (offline mode)
  • Write documentation when there's a new API or functionality

@codecov-commenter
Copy link

codecov-commenter commented Nov 22, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.16%. Comparing base (a98c439) to head (c25940a).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #725   +/-   ##
=======================================
  Coverage   96.16%   96.16%           
=======================================
  Files          24       24           
  Lines        2166     2166           
  Branches      275      275           
=======================================
  Hits         2083     2083           
  Misses         55       55           
  Partials       28       28           
Flag Coverage Δ
macos-latest 96.02% <100.00%> (ø)
ubuntu-latest 96.02% <100.00%> (ø)
windows-latest 96.02% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@andreoliwa andreoliwa marked this pull request as ready for review November 22, 2025 22:07
@andreoliwa andreoliwa changed the title docs: convert ReST to Markdown docs: convert ReST (Sphinx) to Markdown (MkDocs) Nov 23, 2025
@andreoliwa andreoliwa merged commit bd098d8 into master Nov 23, 2025
12 checks passed
@andreoliwa andreoliwa deleted the convert-rst-to-markdown branch November 23, 2025 03:03
@github-actions
Copy link

🎉 This PR is included in version 0.38.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot added the released Feature/fix is released label Nov 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

released Feature/fix is released

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants