diff --git a/docs/source/conf.py b/docs/source/conf.py index cdd36a3fda..98a324a6c4 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -90,7 +90,7 @@ html_theme = "sphinx_material" html_theme_options = { # Set the name of the project to appear in the navigation. - "nav_title": "Flyte", + "nav_title": "Flytekit Python Reference", # Set you GA account ID to enable tracking "google_analytics_account": "G-YQL24L5CKY", # Specify a base_url used to generate sitemap.xml. If not @@ -108,6 +108,15 @@ "globaltoc_collapse": False, # If True, show hidden TOC entries "globaltoc_includehidden": False, + # don't include home link in breadcrumb bar, since it's included + # in the nav_links key below. + "master_doc": False, + # custom nav in breadcrumb bar + "nav_links": [ + {"href": "https://flyte.readthedocs.io/", "internal": False, "title": "Flyte"}, + {"href": "https://flytecookbook.readthedocs.io", "internal": False, "title": "Flytekit Tutorials"}, + {"href": "index", "internal": True, "title": "Flytekit Python Reference"}, + ], } # The default sidebars (for documents that don't match any pattern) are @@ -125,6 +134,7 @@ # Custom sidebar templates, must be a dictionary that maps document names # to template names. # +html_logo = "flyte_circle_gradient_1_4x4.png" # -- Options for HTMLHelp output --------------------------------------------- diff --git a/docs/source/flyte_circle_gradient_1_4x4.png b/docs/source/flyte_circle_gradient_1_4x4.png new file mode 100644 index 0000000000..49cdbbbc34 Binary files /dev/null and b/docs/source/flyte_circle_gradient_1_4x4.png differ diff --git a/docs/source/index.rst b/docs/source/index.rst index a9329fcf1d..0035b514db 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -3,28 +3,13 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -########################################## -Welcome to ``Flytekit``'s documentation! -########################################## +************************* +Flytekit Python Reference +************************* -************* -Flytekit API -************* - -.. toctree:: - :maxdepth: 1 - :caption: APIs - - flytekit - testing - extend - -This section documents the various Python imports users will need to work with to build Flyte workflows, extend Flytekit, etc. - - -******************** -Flytekit Design -******************** +This section of the documentation provides more detailed descriptions of the high-level design of ``flytekit`` and an +API reference for specific usage details of python functions, classes, and decorators that you import to specify tasks, +build workflows, extend ``flytekit``. .. toctree:: :maxdepth: 1 @@ -32,11 +17,13 @@ Flytekit Design design/index -This section details how flytekit is laid out, its general design, and some of the rationale for why it is the way it is. +.. toctree:: + :maxdepth: 1 + :caption: APIs -******************** -Conributing -******************** + flytekit + testing + extend .. toctree:: :maxdepth: 1 @@ -46,17 +33,6 @@ Conributing tasks.extend types.extend -****************************** -Additional Flyte Documentation -****************************** - -.. toctree:: - :maxdepth: 1 - :caption: Other Documentation - - Flyte Documentation - Flytekit Learn by Example - .. toctree:: :maxdepth: 1