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

chore: Clean up KFP SDK docstrings, make formatting a little more consistent #4218

Merged
merged 11 commits into from
Aug 3, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
version: 2
sphinx:
configuration: docs/conf.py
python:
version: 3.7
install:
- requirements: sdk/python/requirements.txt
3 changes: 3 additions & 0 deletions docs/_static/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.rst-content code, .rst-content tt, code {
white-space: normal;
}
7 changes: 5 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@
# -- Project information -----------------------------------------------------

project = 'Kubeflow Pipelines'
copyright = '2019, Google'
copyright = '2020, Google'
author = 'Google'

# The short X.Y version
Expand Down Expand Up @@ -106,7 +106,6 @@
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = None


# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
Expand Down Expand Up @@ -140,6 +139,10 @@
#
# html_sidebars = {}

html_css_files = [
'custom.css',
]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needed this to break the lines of long code blocks, see here for an example.



# -- Options for HTMLHelp output ---------------------------------------------

Expand Down
8 changes: 4 additions & 4 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,20 +3,20 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Kubeflow Pipelines SDK API reference
================================================
Kubeflow Pipelines SDK API
==========================

Main documentation: https://www.kubeflow.org/docs/pipelines/

Source code: https://github.com/kubeflow/pipelines/

.. toctree::
:maxdepth: 3
:caption: Contents:
:caption: Contents

self
source/kfp


.. * :ref:`modindex`
.. * :ref:`kfp-ref`
.. * :ref:`search`
Expand Down
2 changes: 2 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
sphinx==3.1.2
sphinx_rtd_theme==0.5.0
4 changes: 2 additions & 2 deletions docs/source/kfp.client.rst
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
kfp.Client class
------------------
================

.. autoclass:: kfp.Client
:members:
:undoc-members:
:show-inheritance:

Generated APIs
------------------
--------------

.. toctree::
:maxdepth: 2
Expand Down
1 change: 1 addition & 0 deletions docs/source/kfp.components.structures.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ kfp.components.structures package
:imported-members:

.. toctree::
:maxdepth: 2

kfp.components.structures.kubernetes
8 changes: 0 additions & 8 deletions docs/source/kfp.notebook.rst

This file was deleted.

3 changes: 1 addition & 2 deletions docs/source/kfp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,11 @@ kfp package
.. toctree::
:maxdepth: 2

kfp.client
kfp.compiler
kfp.components
kfp.containers
kfp.dsl
kfp.client
kfp.notebook
kfp.extensions

.. automodule:: kfp
Expand Down
7 changes: 0 additions & 7 deletions docs/source/modules.rst

This file was deleted.

Loading