Skip to content
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

Add sphinx docs for Python SDK. #168

Merged
merged 10 commits into from Nov 22, 2019
Merged

Conversation

@zhenghuiwang
Copy link
Contributor

zhenghuiwang commented Nov 15, 2019

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.

Preview: https://kf-metadata-pr-168.readthedocs.io/en/latest/index.html


This change is Reviewable

@k8s-ci-robot k8s-ci-robot requested review from gaoning777 and jinchihe Nov 15, 2019
@k8s-ci-robot k8s-ci-robot added size/L and removed size/XXL labels Nov 15, 2019
@zhenghuiwang zhenghuiwang requested a review from sarahmaddox Nov 15, 2019
@zhenghuiwang

This comment has been minimized.

Copy link
Contributor Author

zhenghuiwang commented Nov 15, 2019

/assign @sarahmaddox

@jinchihe

This comment has been minimized.

Copy link
Member

jinchihe commented Nov 15, 2019

Hello @zhenghuiwang that's really great to generate docs for SDK, I just done that for kubeflow fairing, may I suggest to update to sphinx_rtd_theme style that seems bette, and shall we add content in the index page so that user can click and read that directly as below link:
https://kubeflow-fairing.readthedocs.io/en/latest/index.html

But that's only suggestion, nice to have. That's good for current behavior...haha

@zhenghuiwang

This comment has been minimized.

Copy link
Contributor Author

zhenghuiwang commented Nov 15, 2019

@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 Index page or search.

@jinchihe

This comment has been minimized.

Copy link
Member

jinchihe commented Nov 17, 2019

Sounds great!
/lgtm

@sarahmaddox

This comment has been minimized.

Copy link

sarahmaddox commented Nov 17, 2019

Thanks @zhenghuiwang! When the SDK docs are available on readthedocs.io, we can add a link to them from the Kubeflow website. I'll add a comment to the issue.

/lgtm

@zhenghuiwang

This comment has been minimized.

Copy link
Contributor Author

zhenghuiwang commented Nov 22, 2019

/approve

@k8s-ci-robot

This comment has been minimized.

Copy link

k8s-ci-robot commented Nov 22, 2019

[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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot merged commit fc0acf4 into kubeflow:master Nov 22, 2019
3 checks passed
3 checks passed
cla/google All necessary CLAs are signed
kubeflow-metadata-presubmit Job succeeded.
Details
tide In merge pool.
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants
You can’t perform that action at this time.