Added the auto-generated python SDK docs #1256
Conversation
|
/test kubeflow-pipeline-e2e-test |
Ark-kun
changed the title
|
/test kubeflow-pipeline-e2e-test |
|
Please add a readme file about how to use and generate the doc. |
The docs are built automatically after every master commit.
I've looked at the Google Cloud library and they do not put licenses in the .rst files: https://github.com/googleapis/google-cloud-python/blob/master/storage/docs/buckets.rst |
|
Added the licenses |
|
Added more information to conf.py |
|
Here is the issue to track the setup.py and requirements.txt: #1271 |
|
/lgtm |
|
/approve |
|
/test kubeflow-pipeline-e2e-test |
2 similar comments
|
/test kubeflow-pipeline-e2e-test |
|
/test kubeflow-pipeline-e2e-test |
|
Could you please validate with @abhi-g, @paveldournov, @theadactyl that they agree with the choice or readthedocs to store documentation? |
|
/cc @sarahmaddox for opinion on this. I know that we have a bunch of other auto generated documentation that already gets published through Kubeflow website. |
|
Thanks for pulling me in, @abhi-g. It's best to keep the Kubeflow docs in one place. As you mentioned, we already have auto-generated reference docs on the website: To keep the pipelines docs together, we have a reference section under pipelines, where we should add the generated reference docs: We also have some info on generating the ref docs - we should add the pipelines instructions here too: |
Can you add a "proxy" to the documentation website so that the reference docs have kubeflow.org URLs, but are served from elsewhere? |
|
opensource-licensing had approved the usage of the ReadTheDocs service. /cc @paveldournov |
|
/cc @paveldournov |
|
|
||
| import os | ||
| import sys | ||
| #sys.path.insert(0, os.path.abspath('.')) |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Ark-kun, paveldournov 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 |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Ark-kun, paveldournov 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 |
Adding the Sphinx-based documentation generation.
The documentation files are picked up by the http://readthedocs.org to build the whole documentation website.
The documentation is published at https://kf-pipelines.readthedocs.io/en/latest/source/kfp.html
This change is