From d20ef0cb4863766264ec47ec550df100959a769f Mon Sep 17 00:00:00 2001 From: Niels Bantilan Date: Fri, 7 Jan 2022 19:19:12 -0500 Subject: [PATCH] update flytectl for new navbar (#259) --- docs/source/conf.py | 3 ++- docs/source/contribute.rst | 2 +- docs/source/index.rst | 11 +++++++---- 3 files changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 6767fad9e7..aeaa2ae410 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -89,8 +89,9 @@ # a list of builtin themes. # html_theme = "furo" -html_title = "Flyte Docs" +html_title = "Flyte" html_logo = "flyte_circle_gradient_1_4x4.png" +html_favicon = "flyte_circle_gradient_1_4x4.png" html_theme_options = { "light_css_variables": { diff --git a/docs/source/contribute.rst b/docs/source/contribute.rst index a623d3f159..864fda4e61 100644 --- a/docs/source/contribute.rst +++ b/docs/source/contribute.rst @@ -1,5 +1,5 @@ ########################### -FlyteCTL Contribution Guide +Contributing Guide ########################### First off, thank you for thinking about contributing! diff --git a/docs/source/index.rst b/docs/source/index.rst index 88a895f174..3f73b6b834 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,8 +1,8 @@ .. flytectl doc -###################### -Flytectl Reference -###################### +#################################################### +Flytectl: The Official Flyte Command-line Interface +#################################################### Overview ========= @@ -139,12 +139,15 @@ The full list of available configurable options can be found by running ``flytec |book| API Reference |hands-helping| Community + +.. NOTE: the caption text is important for the sphinx theme to correctly render the nav header +.. https://github.com/flyteorg/furo .. toctree:: :maxdepth: -1 :caption: Flytectl :hidden: - Install and Configure + Flytectl CLI Entrypoint verbs nouns