-
Notifications
You must be signed in to change notification settings - Fork 25
feat: API documentation site using Github pages #303
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
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>
|
Perhaps we should add something in CI to make sure the docs are updated and if not CI should fail? |
I will have to experiment a little to make it work in the CI. I will do it in a followup PR |
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: