add main nav font awesome icons (#170)

* add main nav font awesome icons Signed-off-by: cosmicBboy <[email protected]> * add "edit on github button" config Signed-off-by: cosmicBboy <[email protected]> * fix html theme config Signed-off-by: cosmicBboy <[email protected]>
flyteorg · May 24, 2021 · adb8ab8 · adb8ab8
1 parent 7b4391b
commit adb8ab8
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 13 deletions.
diff --git a/flyteidl/conf.py b/flyteidl/conf.py
@@ -17,6 +17,7 @@
 import sys
 
 import recommonmark
+import sphinx_fontawesome
 from recommonmark.transform import AutoStructify
 
 
@@ -50,6 +51,7 @@
     "sphinx_search.extension",
     "recommonmark",
     "sphinx_markdown_tables",
+    "sphinx_fontawesome",
 ]
 
 # build the templated autosummary files
@@ -106,6 +108,11 @@
         "color-brand-primary": "#9D68E4",
         "color-brand-content": "#9D68E4",
     },
+    # custom flyteorg furo theme options
+    "github_repo": "flyteidl",
+    "github_username": "flyteorg",
+    "github_commit": "master",
+    "docs_path": ".",  # path to documentation source
 }
 
 html_context = {

diff --git a/flyteidl/doc-requirements.in b/flyteidl/doc-requirements.in
@@ -7,3 +7,4 @@ sphinx-material
 sphinx-code-include
 sphinx-copybutton
 sphinx_markdown_tables
+sphinx_fontawesome
diff --git a/flyteidl/doc-requirements.txt b/flyteidl/doc-requirements.txt
@@ -31,23 +31,23 @@ idna==2.10
     # via requests
 imagesize==1.2.0
     # via sphinx
-jinja2==2.11.3
+jinja2==3.0.1
     # via sphinx
 lxml==4.6.3
     # via sphinx-material
 markdown==3.3.4
     # via sphinx-markdown-tables
-markupsafe==1.1.1
+markupsafe==2.0.1
     # via jinja2
 packaging==20.9
     # via sphinx
-pygments==2.8.1
+pygments==2.9.0
     # via
     #   sphinx
     #   sphinx-prompt
 pyparsing==2.4.7
     # via packaging
-python-slugify[unidecode]==4.0.1
+python-slugify[unidecode]==5.0.2
     # via sphinx-material
 pytz==2021.1
     # via babel
@@ -57,7 +57,7 @@ recommonmark==0.7.1
     # via -r doc-requirements.in
 requests==2.25.1
     # via sphinx
-six==1.15.0
+six==1.16.0
     # via sphinx-code-include
 snowballstemmer==2.1.0
     # via sphinx
@@ -67,6 +67,8 @@ sphinx-code-include==1.1.1
     # via -r doc-requirements.in
 sphinx-copybutton==0.3.1
     # via -r doc-requirements.in
+sphinx-fontawesome==0.0.6
+    # via -r doc-requirements.in
 sphinx-markdown-tables==0.0.15
     # via -r doc-requirements.in
 sphinx-material==0.0.32
@@ -80,19 +82,20 @@ sphinx==3.5.4
     #   recommonmark
     #   sphinx-code-include
     #   sphinx-copybutton
+    #   sphinx-fontawesome
     #   sphinx-material
     #   sphinx-prompt
 sphinxcontrib-applehelp==1.0.2
     # via sphinx
 sphinxcontrib-devhelp==1.0.2
     # via sphinx
-sphinxcontrib-htmlhelp==1.0.3
+sphinxcontrib-htmlhelp==2.0.0
     # via sphinx
 sphinxcontrib-jsmath==1.0.1
     # via sphinx
 sphinxcontrib-qthelp==1.0.3
     # via sphinx
-sphinxcontrib-serializinghtml==1.1.4
+sphinxcontrib-serializinghtml==1.1.5
     # via sphinx
 text-unidecode==1.3
     # via python-slugify

diff --git a/flyteidl/index.rst b/flyteidl/index.rst
@@ -16,12 +16,12 @@ This specification is used to generate client stubs for `FlyteKit <https://flyte
    :maxdepth: 1
    :hidden:
 
-   Getting Started <https://docs.flyte.org/en/latest/getting_started.html>
-   User Guide <https://docs.flyte.org/projects/cookbook/en/latest/user_guide.html>
-   Tutorials <https://docs.flyte.org/projects/cookbook/en/latest/tutorials.html>
-   Concepts <https://docs.flyte.org/en/latest/concepts/basics.html>
-   API Reference <https://docs.flyte.org/en/latest/reference/index.html>
-   Community <https://docs.flyte.org/en/latest/community/index.html>
+   |plane| Getting Started <https://docs.flyte.org/en/latest/getting_started.html>
+   |book-reader| User Guide <https://docs.flyte.org/projects/cookbook/en/latest/user_guide.html>
+   |chalkboard| Tutorials <https://docs.flyte.org/projects/cookbook/en/latest/tutorials.html>
+   |project-diagram| Concepts <https://docs.flyte.org/en/latest/concepts/basics.html>
+   |book| API Reference <https://docs.flyte.org/en/latest/reference/index.html>
+   |hands-helping| Community <https://docs.flyte.org/en/latest/community/index.html>
 
 .. toctree::
    :maxdepth: -1