Sphinx setup for sdk docs generation #2415
Conversation
Signed-off-by: shivas1516 <[email protected]>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
google-oss-prow
bot
requested review from
anencore94,
gaocegege and
johnugeorge
|
/area gsoc |
hack/gen-python-sdk/post_gen.py
Outdated
|
|
||
| if __name__ == "__main__": | ||
| update_python_sdk(src=sys.argv[1], dest=sys.argv[2]) | ||
|
|
||
| # SDK docs update | ||
| upgate_python_sdk_docs() |
hack/gen-python-sdk/post_gen.py
Outdated
| @@ -183,6 +184,29 @@ def update_python_sdk(src, dest, versions=("v1beta1")): | |||
| # Clear working dictionary | |||
| shutil.rmtree(src) | |||
|
|
|||
| def upgate_python_sdk_docs(): | |||
There was a problem hiding this comment.
@shivaylamba I’ve removed the update_python_sdk_docs() method. It appears that Read the Docs updates the documentation automatically using the .readthedocs.yaml configuration, so there's no need for a separate workflow.
sdk/python/v1beta1/README.md
Outdated
| ## Author | ||
|
|
||
| prem0912 | ||
| Please follow the [examples](https://github.com/shivas1516/katib/tree/master/sdk) to learn more about Katib SDK. |
There was a problem hiding this comment.
THis has to be replaced with the actual github repo
sdk/python/v1beta1/README.md
Outdated
|
|
||
| You can find the Katib Python SDK in the [`kubeflow-katib` package on PyPi](https://pypi.org/project/kubeflow-katib/). | ||
|
|
||
| For detailed information on the release process, please refer to the [release script](https://github.com/shivas1516/katib/blob/master/scripts/v1beta1/release.sh) in the Katib repository. |
There was a problem hiding this comment.
needs to be replaced with main repo
There was a problem hiding this comment.
updated in the recent push, let me know if there are additional changes sir
|
Also ensure if you can pass the failing linting and go tests |
|
@shivas1516 Please can you rise a PR for Training Operator as well since it doesn't have this problem with gRPC import package ? |
Signed-off-by: shivas1516 <[email protected]>
Sure, I configured the Sphinx and completed the docs for the client but most of the docstrings in each models are not friendly to the Sphinx and need to be manually altered it. demo link: https://testtrainingoperator.readthedocs.io/en/latest/index.html |
Signed-off-by: shivas1516 <[email protected]>
What this PR does / why we need it:
This PR sets the Sphinx configuration for generating the Katib SDK API reference documentation. It also includes updates to
gen_python.pyto build the documentation in Markdown format.Which issue(s) this PR fixes (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close the issue(s) when PR gets merged):Fixes #2373
Demo Link: https://katib-demo.readthedocs.io/en/latest/index.html
Note: Before merging this into the main branch, we must create a new Read the Docs project and import the katib repo to it.
Error:
seeking for suggestions to resolve this error
Checklist: