Skip to content

Add script to automatically generate API documentation #6755

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

Merged
merged 7 commits into from
Jul 7, 2025
Merged

Conversation

ekzhu
Copy link
Collaborator

@ekzhu ekzhu commented Jul 6, 2025

Added a new script generate_api_doc.py to automatically populate RST files and index.md file for the API Reference page.

Copy link

codecov bot commented Jul 6, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 80.44%. Comparing base (13f9a73) to head (459d25c).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #6755      +/-   ##
==========================================
+ Coverage   80.42%   80.44%   +0.01%     
==========================================
  Files         234      237       +3     
  Lines       17863    17866       +3     
==========================================
+ Hits        14367    14372       +5     
+ Misses       3496     3494       -2     
Flag Coverage Δ
unittests 80.44% <100.00%> (+0.01%) ⬆️

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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@ekzhu ekzhu merged commit 89841b6 into main Jul 7, 2025
68 checks passed
@ekzhu ekzhu deleted the ekzhu-auto-doc branch July 7, 2025 01:38
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.

1 participant