Commit Graph

9 Commits

Author SHA1 Message Date
Alex Latchford 704c8c7660
chore: Clean up KFP SDK docstrings, make formatting a little more consistent (#4218)
* Prepare SDK docs environment so its easier to understand how to build the docs locally so theyre consistent with ReadTheDocs.

* Clean up docstrings for kfp.Client

* Add in updates to the docs for compiler and components

* Update components area to add in code references and make formatting a little more consistent.

* Clean up containers, add in custom CSS to ensure we do not overflow on inline code blocks

* Clean up containers, add in custom CSS to ensure we do not overflow on inline code blocks

* Remove unused kfp.notebook package links

* Clean up a few more errant references

* Clean up the DSL docs some more

* Update SDK docs for KFP extensions to follow Sphinx guidelines

* Clean up formatting of docstrings after Ark-Kuns comments
2020-08-04 00:33:47 +08:00
Alexey Volkov d472d53a85
Docs - Show inherited members in the kfp.dsl docs (#4025)
Previously many ContainerOp members inherited from baseOp were not shown.
2020-06-18 19:25:58 -07:00
Alexey Volkov 180f0c51c8
Docs - Moved the kfp_server_api documentation to a separate page (#3899) 2020-06-04 11:15:56 +08:00
Alexey Volkov c67bc7baa9
Docs - Added docs for kfp_server_api.models (#3898) 2020-06-03 01:00:17 -07:00
Alexey Volkov 43ce6394bf
Docs - Added kfp.dsl placeholders to docs (#3813) 2020-05-22 13:23:14 -07:00
Alexey Volkov 4a961ce268
Client - Added documentation for the generated members (#3787) 2020-05-20 13:20:20 -07:00
Alexey Volkov 5163a6fdeb Docs - Added the kfp root members (#2183) 2019-10-07 18:33:19 -07:00
Alexey Volkov 9c9fb9d87e Docs - Added kfp.containers module (#2182)
And fixed the docstring
2019-09-24 13:43:59 -07:00
Alexey Volkov 329e8a50f0 Added the auto-generated python SDK docs (#1256)
* Added Python API reference docs

* Switched to the RTD theme

* Imporved the documentation

* Improved the docs

* Simplified the generator files

* Added sdk/python/requirements.txt

* Added licenses

* Added more information and comments to the conf.py file

* Added kfp.aws

* Fixed typos

* Removed the header

* Hiding some private classes

* Removed the explicit inclusion of kfp.components.structures as per Ning's request

* Added OWNERS file

* Changed the index title

* Removed the subheader

* Added the links to main documentation and source code

* Removed the listing of the kfp.components._structures
2019-05-17 18:55:06 -07:00