diff --git a/flytectl/doc-requirements.in b/flytectl/doc-requirements.in index 8a0e088122..3cf9da6f2f 100644 --- a/flytectl/doc-requirements.in +++ b/flytectl/doc-requirements.in @@ -1,4 +1,4 @@ -furo +git+git://github.com/flyteorg/furo@main readthedocs-sphinx-search sphinx sphinx-prompt diff --git a/flytectl/doc-requirements.txt b/flytectl/doc-requirements.txt index d01f9385bf..8df6e8b686 100644 --- a/flytectl/doc-requirements.txt +++ b/flytectl/doc-requirements.txt @@ -6,7 +6,7 @@ # alabaster==0.7.12 # via sphinx -babel==2.9.0 +babel==2.9.1 # via sphinx beautifulsoup4==4.9.3 # via @@ -21,7 +21,7 @@ css-html-js-minify==2.5.5 # via sphinx-material docutils==0.16 # via sphinx -furo==2021.3.20b30 +git+git://github.com/flyteorg/furo@main # via -r doc-requirements.in idna==2.10 # via requests @@ -63,7 +63,7 @@ sphinx-material==0.0.32 # via -r doc-requirements.in sphinx-prompt==1.4.0 # via -r doc-requirements.in -sphinx==3.5.3 +sphinx==3.5.4 # via # -r doc-requirements.in # furo diff --git a/flytectl/docs/source/_static/custom.css b/flytectl/docs/source/_static/custom.css deleted file mode 100644 index d9851b7d8f..0000000000 --- a/flytectl/docs/source/_static/custom.css +++ /dev/null @@ -1,91 +0,0 @@ -h1, h2, h3, h4, h5, h6 { - font-weight: bold; -} - -.sidebar-logo { - max-width: 30%; -} - - -.sidebar-tree .reference.external:after { - content: none; -} - -.sphx-glr-thumbcontainer { - background-color: transparent; - border: transparent; -} - -.sphx-glr-thumbcontainer:hover { - border: transparent; -} - -div.sphx-glr-download a { - color:white; - background-color: #9d68e4cf; - background-image: none; - border: 1px solid #9d68e4cf; -} - -div.sphx-glr-download a:hover { - background-color: #8b48e2cf; - box-shadow: none; -} - -div.sphx-glr-thumbcontainer a.headerlink { - display: none; -} - -div.sphx-glr-thumbcontainer:hover { - border-color: white; - box-shadow: none; -} - -.sphx-glr-script-out .highlight pre { - background-color: #f8f8f8; -} - -p.sphx-glr-script-out { - padding-top: 0em; -} - -.search__outer::-webkit-scrollbar-track { - border-radius: 0px; -} - -@media (prefers-color-scheme: dark) { - .search__outer { - background-color: #131416 !important; - border: 1px solid #131416 !important; - } - .search__outer__input { - background-color: #1a1c1e !important; - } - .search__result__single { - border-bottom: #303335 !important; - } - .outer_div_page_results:hover { - background-color: black; - } - .search__result__title, .rtd_ui_search_subtitle { - color: #9D68E4 !important; - border-bottom: 1px solid #9D68E4 !important; - } - .search__outer .search__result__title span, .search__outer .search__result__content span { - background-color: #9d68e454; - } - .search__result__subheading, .search__result__content { - color: #ffffffd9 !important; - } - .search__outer::-webkit-scrollbar-track { - background-color: #131416 !important; - } - .rtd__search__credits { - background-color: #1a1c1e !important; - border: 1px solid #1a1c1e !important; - color: #81868d !important; - } - .rtd__search__credits a, .search__error__box { - color: #9ca0a5 !important; - } - } diff --git a/flytectl/docs/source/conf.py b/flytectl/docs/source/conf.py index 51ec8df120..9874c85aa7 100644 --- a/flytectl/docs/source/conf.py +++ b/flytectl/docs/source/conf.py @@ -115,9 +115,6 @@ # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ["_static"] -html_css_files = [ - "custom.css", -] # Custom sidebar templates, must be a dictionary that maps document names # to template names. diff --git a/flytectl/docs/source/gen/flytectl_update.rst b/flytectl/docs/source/gen/flytectl_update.rst index e3e03e6496..7db54b49a6 100644 --- a/flytectl/docs/source/gen/flytectl_update.rst +++ b/flytectl/docs/source/gen/flytectl_update.rst @@ -76,5 +76,5 @@ SEE ALSO * :doc:`flytectl_update_launchplan` - Updates launch plan metadata * :doc:`flytectl_update_project` - Updates project resources * :doc:`flytectl_update_task` - Updates task metadata -* :doc:`flytectl_update_workflow` - Updates launch plan metadata +* :doc:`flytectl_update_workflow` - Updates workflow metadata diff --git a/flytectl/docs/source/gen/flytectl_update_launchplan.rst b/flytectl/docs/source/gen/flytectl_update_launchplan.rst index a110317ff2..49bf4bffa9 100644 --- a/flytectl/docs/source/gen/flytectl_update_launchplan.rst +++ b/flytectl/docs/source/gen/flytectl_update_launchplan.rst @@ -10,7 +10,6 @@ Synopsis -Updates launchplan metadata. Following command updates the description on the launchplan. :: diff --git a/flytectl/docs/source/gen/flytectl_update_project.rst b/flytectl/docs/source/gen/flytectl_update_project.rst index d3b2d44096..4a6e7bee48 100644 --- a/flytectl/docs/source/gen/flytectl_update_project.rst +++ b/flytectl/docs/source/gen/flytectl_update_project.rst @@ -10,7 +10,7 @@ Synopsis -Updates the project according the flags passed.Allows you to archive or activate a project. +Updates the project according the flags passed. Allows you to archive or activate a project. Activates project named flytesnacks. :: diff --git a/flytectl/docs/source/gen/flytectl_update_task.rst b/flytectl/docs/source/gen/flytectl_update_task.rst index 358537b9c3..5a81366eb8 100644 --- a/flytectl/docs/source/gen/flytectl_update_task.rst +++ b/flytectl/docs/source/gen/flytectl_update_task.rst @@ -10,18 +10,17 @@ Synopsis -Updates task metadata. Following command updates the description on the task. :: flytectl update task -d development -p flytectldemo core.advanced.run_merge_sort.merge --description "Merge sort example" -Archiving task named entity would is not supported and would throw an error. +Archiving task named entity is not supported and would throw an error. :: flytectl update task -d development -p flytectldemo core.advanced.run_merge_sort.merge --archive -Activating workflow named entity would be a noop as archiving is not possible. +Activating task named entity would be a noop as archiving is not possible. :: flytectl update task -d development -p flytectldemo core.advanced.run_merge_sort.merge --activate diff --git a/flytectl/docs/source/gen/flytectl_update_workflow.rst b/flytectl/docs/source/gen/flytectl_update_workflow.rst index 2cdd0c21ea..553446ca27 100644 --- a/flytectl/docs/source/gen/flytectl_update_workflow.rst +++ b/flytectl/docs/source/gen/flytectl_update_workflow.rst @@ -3,14 +3,13 @@ flytectl update workflow ------------------------ -Updates launch plan metadata +Updates workflow metadata Synopsis ~~~~~~~~ -Updates workflow metadata. Following command updates the description on the workflow. :: @@ -21,7 +20,7 @@ Archiving workflow named entity would cause this to disapper from flyteconsole U flytectl update workflow -p flytectldemo -d development core.advanced.run_merge_sort.merge_sort --archive -Activating workflow named entity would unarchive it. +Activating workflow named entity :: flytectl update workflow -p flytectldemo -d development core.advanced.run_merge_sort.merge_sort --activate diff --git a/flytectl/docs/source/index.rst b/flytectl/docs/source/index.rst index 0f381d5e59..44d061489d 100644 --- a/flytectl/docs/source/index.rst +++ b/flytectl/docs/source/index.rst @@ -41,49 +41,18 @@ Basic Configuration :hidden: Getting Started - Tutorials - reference/index + User Guide + Tutorials + Concepts + API Reference Community .. toctree:: - :maxdepth: 1 + :maxdepth: -1 :caption: Flytectl :hidden: Install and Configure - -.. toctree:: - :maxdepth: 1 - :caption: Verbs - :hidden: - - gen/flytectl_create - gen/flytectl_get - gen/flytectl_update - gen/flytectl_delete - gen/flytectl_register - gen/flytectl_config - -.. toctree:: - :maxdepth: 1 - :caption: Nouns - :hidden: - - gen/flytectl_create_project - gen/flytectl_create_execution - gen/flytectl_get_execution - gen/flytectl_get_project - gen/flytectl_get_workflow - gen/flytectl_get_task - gen/flytectl_get_launchplan - gen/flytectl_update_project - gen/flytectl_register_files - gen/flytectl_version - gen/flytectl_config_validate - -.. toctree:: - :maxdepth: 2 - :caption: Contribute - :hidden: - - contribute + verbs + nouns + Contribute diff --git a/flytectl/docs/source/nouns.rst b/flytectl/docs/source/nouns.rst new file mode 100644 index 0000000000..78996e38ce --- /dev/null +++ b/flytectl/docs/source/nouns.rst @@ -0,0 +1,19 @@ +Nouns +------ + +.. toctree:: + :maxdepth: 1 + :caption: Nouns + :hidden: + + gen/flytectl_create_project + gen/flytectl_create_execution + gen/flytectl_get_execution + gen/flytectl_get_project + gen/flytectl_get_workflow + gen/flytectl_get_task + gen/flytectl_get_launchplan + gen/flytectl_update_project + gen/flytectl_register_files + gen/flytectl_version + gen/flytectl_config_validate diff --git a/flytectl/docs/source/reference/index.rst b/flytectl/docs/source/reference/index.rst deleted file mode 100644 index 6b6ff34c49..0000000000 --- a/flytectl/docs/source/reference/index.rst +++ /dev/null @@ -1,24 +0,0 @@ -############# -API Reference -############# - -.. toctree:: - :maxdepth: 1 - :caption: API Reference - :name: apitoc - - Flytekit Python - Flytekit Java - FlyteIDL - Flytectl - -.. toctree:: - :maxdepth: 1 - :caption: Component Reference (Code docs) - :name: componentreftoc - - FlytePropeller - FlyteAdmin - FlytePlugins - DataCatalog - \ No newline at end of file diff --git a/flytectl/docs/source/verbs.rst b/flytectl/docs/source/verbs.rst new file mode 100644 index 0000000000..49f90367b0 --- /dev/null +++ b/flytectl/docs/source/verbs.rst @@ -0,0 +1,14 @@ +Verbs +------ + +.. toctree:: + :maxdepth: 1 + :caption: Verbs + :hidden: + + gen/flytectl_create + gen/flytectl_get + gen/flytectl_update + gen/flytectl_delete + gen/flytectl_register + gen/flytectl_config \ No newline at end of file