Commit Graph

13 Commits

Author SHA1 Message Date
Connor McCarthy 30669e46dc
chore(sdk): improve KFP SDK reference documentation (#8337)
* use autodoc default options

* sort symbol order by typical usage patterns

* include summary of submodule symbols

* expose Input[] and Output[] type generics

* include tables of contents on API reference docs pages

* expand global TOC for discoverability

* fix missing reference / circular import problem
2022-10-17 19:58:53 +00:00
Connor McCarthy e47a784035
docs(sdk): clean up kfp v2 cli reference docs (#8115)
* use expanded "Command Line Interface" for title

* remove alpha feature stage in help text

* hide deprecated argument

* use compile as command name
2022-08-09 18:40:39 +00:00
Connor McCarthy c6a5e387dd
docs(sdk): refresh SDK public API docstrings (#8057)
* add module-level docstrings

* update compiler docstrings

* update registry module docstrings

* add BaseComponent and children to public api, but discourage use

* update artifact docstrings and type annotations

* update dsl docstrings

* update client docstrings

* clean up kfp.__init__

* add dsl placeholder docstrings

* many more docstring updates

* document type aliases in dsl module
2022-07-21 19:51:18 +00:00
Connor McCarthy d8b9439ef9
add kfp v2 api reference docs (#8042)
* use __all__ in top-level modules to record public api

* add index and source files

* add kubeflow assets to _static/

* add and pin requirements

* use block quote instead of header for readme notice

* update conf.py

* delete old files
2022-07-19 15:53:54 -06:00
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