feat: API documentation site using Github pages#303
Merged
Conversation
Signed-off-by: Sreekanth <prsreekanth920@gmail.com>
Signed-off-by: Sreekanth <prsreekanth920@gmail.com>
Signed-off-by: Sreekanth <prsreekanth920@gmail.com>
Signed-off-by: Sreekanth <prsreekanth920@gmail.com>
Codecov Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
Signed-off-by: Sreekanth <prsreekanth920@gmail.com>
Signed-off-by: Sreekanth <prsreekanth920@gmail.com>
Signed-off-by: Sreekanth <prsreekanth920@gmail.com>
Member
|
Perhaps we should add something in CI to make sure the docs are updated and if not CI should fail? |
Contributor
Author
I will have to experiment a little to make it work in the CI. I will do it in a followup PR |
vigith
approved these changes
Jan 11, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR creates a new API documentation site for Python SDK for hosting using Github pages.
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-sitebranch on this repo).Run below command from
mainbranch and it will generate the docs and push it todocs-sitebranch: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: