Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
Add sphinx docs for Python SDK. #168
Related to kubeflow/website#1206
This PR aims to check in the configuration to auto generate python docs from python docstrings, using readthedocs.io
The improvement of the actual doc content should be done in subsequent PR on docstrings.
Hello @zhenghuiwang that's really great to generate docs for SDK, I just done that for kubeflow fairing, may I suggest to update to
But that's only suggestion, nice to have. That's good for current behavior...haha
@jinchihe Thanks for the suggestions! I change the theme and it looks much better.
Fairing has many submodules and TOC helps to navigate among them. This sdk has a single module with a bunch of classes. I don't find a good sphinx plugin to automatically generate the TOC for these classes. I will leave the navigation to the
[APPROVALNOTIFIER] This PR is APPROVED
This pull-request has been approved by: zhenghuiwang
The full list of commands accepted by this bot can be found here.
The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing