Skip to content

Conversation

@BulkBeing
Copy link
Contributor

This PR creates a new API documentation site for Python SDK for hosting using Github pages.

Screenshot 2026-01-09 at 8 46 58 AM Screenshot 2026-01-09 at 8 47 11 AM Screenshot 2026-01-09 at 8 47 51 AM

As of now I have not made it part of the CI pipeline, generating documentation has to be ran from one of the maintainers laptop (anyone who has push access to docs-site branch on this repo).
Run below command from main branch and it will generate the docs and push it to docs-site branch:

make docs-deploy-version VERSION=0.11

This uses mike to manage multiple versions of the documentation. So when more versions are available, there will be an option to switch between different versions of the documentation site like below:

Screenshot 2026-01-09 at 8 53 28 AM

@codecov
Copy link

codecov bot commented Jan 9, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 93.91%. Comparing base (2ebe47f) to head (5dcc129).

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #303      +/-   ##
==========================================
+ Coverage   93.81%   93.91%   +0.09%     
==========================================
  Files          66       66              
  Lines        3058     3055       -3     
  Branches      159      156       -3     
==========================================
  Hits         2869     2869              
  Misses        139      139              
+ Partials       50       47       -3     

☔ 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.

Signed-off-by: Sreekanth <[email protected]>
@BulkBeing BulkBeing requested review from kohlisid and yhl25 January 9, 2026 03:28
Signed-off-by: Sreekanth <[email protected]>
Signed-off-by: Sreekanth <[email protected]>
@vigith
Copy link
Member

vigith commented Jan 9, 2026

Perhaps we should add something in CI to make sure the docs are updated and if not CI should fail?

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.

3 participants