update docs for new navbar theme (flyteorg#806)

Signed-off-by: Kenny Workman <[email protected]>
kennyworkman · Jan 8, 2022 · 286ba83 · 286ba83
1 parent 13b71cc
commit 286ba83
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -20,7 +20,7 @@
 
 # -- Project information -----------------------------------------------------
 
-project = "Flyte Cookbook [Python]"
+project = "Flytekit"
 copyright = "2021, Flyte"
 author = "Flyte"
 
@@ -90,7 +90,7 @@
 # a list of builtin themes.
 #
 html_theme = "furo"
-html_title = "Flyte Docs"
+html_title = "Flyte"
 
 html_theme_options = {
     "light_css_variables": {
@@ -126,6 +126,7 @@
 # to template names.
 #
 html_logo = "flyte_circle_gradient_1_4x4.png"
+html_favicon = "flyte_circle_gradient_1_4x4.png"
 
 pygments_style = "tango"
 pygments_dark_style = "native"

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -62,6 +62,8 @@ Expected output:
    |book| API Reference <https://docs.flyte.org/en/latest/reference/index.html>
    |hands-helping| Community <https://docs.flyte.org/en/latest/community/index.html>
 
+.. 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: Flytekit SDK